From 475e7930ed332500bc5d6d49fb9aaa1db47e641f Mon Sep 17 00:00:00 2001 From: Automated MSK Jenkins User Date: Sun, 5 Jan 2025 06:40:23 +0000 Subject: [PATCH] Automated documentation update --- AmtfDbAccess/head/graph_legend.html | 2 +- AmtfDbAccess/head/index.html | 2 +- .../head/html/.doctrees/deviceaccess.doctree | Bin 275593 -> 275593 bytes .../head/html/.doctrees/environment.pickle | Bin 120881 -> 120881 bytes .../head/html/deviceaccess.html | 30 +++++++++--------- .../head/html/searchindex.js | 2 +- .../tag/html/.doctrees/deviceaccess.doctree | Bin 275353 -> 275353 bytes .../tag/html/.doctrees/environment.pickle | Bin 120875 -> 120875 bytes .../tag/html/deviceaccess.html | 30 +++++++++--------- .../tag/html/searchindex.js | 2 +- index.html | 2 +- 11 files changed, 35 insertions(+), 35 deletions(-) diff --git a/AmtfDbAccess/head/graph_legend.html b/AmtfDbAccess/head/graph_legend.html index 2edae00ba14..d93bc7504d2 100644 --- a/AmtfDbAccess/head/graph_legend.html +++ b/AmtfDbAccess/head/graph_legend.html @@ -129,7 +129,7 @@
-Generated on Fri Jan 3 2025 18:57:56 for AmtfDbAccess library by   +Generated on Sat Jan 4 2025 18:58:13 for AmtfDbAccess library by   doxygen 1.8.17
diff --git a/AmtfDbAccess/head/index.html b/AmtfDbAccess/head/index.html index c269dcef783..7e3ba118342 100644 --- a/AmtfDbAccess/head/index.html +++ b/AmtfDbAccess/head/index.html @@ -69,7 +69,7 @@
-Generated on Fri Jan 3 2025 18:57:56 for AmtfDbAccess library by   +Generated on Sat Jan 4 2025 18:58:13 for AmtfDbAccess library by   doxygen 1.8.17
diff --git a/ChimeraTK-DeviceAccess-PythonBindings/head/html/.doctrees/deviceaccess.doctree b/ChimeraTK-DeviceAccess-PythonBindings/head/html/.doctrees/deviceaccess.doctree index 21a5df70ee3b38d36da4c1d19b0ffe34abcc447e..24fcf087744729b2eb9b5423074572b33b4b3748 100644 GIT binary patch delta 1055 zcmeBtDbV>+V8abxPU9p)qZG5m6obtVeI=L>-02A`m}EE02lya~O+G(6520dm?>VW> zticwxAR$AGq(oDT&2AI6Fe13q=X_&yLU1?xO=@68(*Mv`b~;}ov)J_in;2QAU*KWn z*(^QdAXq=dNnkfjmJiU_tTk&6k~kK3B+QZ0MKyZ!f|I|I^dQW7d0GXhpEmcNW3fXu zXL{ToX0h#Oc^H?YnIDlub*GWS7mdR#@+k+V8abx&LrbR3riD=6ywbgeI=L>-02A`m}EE02lya~O+G(6520dm?>VW> zticwxAR%)TOH0$F&2AI6Fe13q=X_&yLU1?xO=@68(*Mv`b~;}ov)J_in;2QAU*KWn z*(^QdAXq=dNnkfjmJiU_tTk&6k~kK3B+QZ0MKyZ!f|I|I^dQW7d0GXhpEmcNW3fXu zXL{ToX0h#Oc^H?YnIDlub*GWS7=1FEI+k=Y+%0q))&T|VC4`#Tsc(w`8USibx5|=E@irf6mHvr=|dTbj~OT1WmhwW zmm`~?#5@^E$87%g5YD8H9g#FY)J+@POKr!A4K9w?Ke3%%H!--W+)&$f;;2=rBFixl%WZxf zQG^}RoB%0;qGx3&2-IUafD&0M7bJ2*AgY28AUHIo5)$-)2se-bG4JiVz~!5n@6F7c zdHZR%w~X6c#;u#Sbld!;x#A1;jn28^^YevbzECJuD)p-y?fG(fc5b0isjt@ErCMuC z%gOlnyB7^#9Y0p8K8U`J+e$A!h<;R&wb>P@vAF&Bc3!huFI8FGVJ7Nn$8S(&Jx)hs zaUcO5{Iv8AhbsHn`3Te+yG|dlUtCV+ANqtc$B$XrA=h`TYskrZ-5)`jrYBm!N@OqmC`)E$7zalzCpq@-w5Fi zzq7qiUZ@o7r5ZagyU_Cu93)&a-#0?%HLh+4cd1rPrx+)+jNQkV~t3WV5R z*hF4iM0~LbUvxb(LHKE8lF$_83~&7|_1g=#?c=L%MpML|RV4QLX_H{$5i9p`HU|d; zac(q3DV+8yhcT0cPSGb$*sJjVXO)1Sa9`<1B?k{tcuP4YjwE&=rZt{a!^BvE61%S2 z$-740U3G{&Lo74}_f;%a2XjL|L3vGNk>`03vnT#U3bm(1lE$};< z)N(ODM>U*k-gS9-eue7|-$(X23}%p8?vK8=Ec} zUPIqE*rko;#(Qb7;En>_`}tKk7K1_UXb|HnnDI50s{-?9fZmFm0ihv1TLl-fKM<=O zO88}te=+oCfnJpxiIu~>{DEy02J4nZGYNrL_mEjCz16xS2?OF4)5f^qaB;kHv?vawkq~a mf=AO(_p`;7#OeIv#C*A!$*(-eKkd>C&=2CnS7zY7^?v}35v@)D delta 1385 zcmY*ZOKe+J5Y42G9g#Gj)=e7QkJ^qC8w`%0Ke3(nOkyyp+)&$f;;2=rBFixl%QPQH z6x9xCHhiQAimsKRAP{0z7NA6y$_9z7_=u{oC=x81(iL=p2s@AfG55ab0-G~4=g!QX zx$o%hY#VpBjoa64>CXA$3k!u}zECJuD)r5_g$wh=7wcCx+w^XhFesMXOfB19CoOr~_j=H{QUBgb+>;4pKjhpUDD}}v{ ztmms%(S8c3deEDs^yj^DH=pZDDR!Wxl-3m_l*)> z^E=xM<;6;|UaGQlvI{-m!4cvmIYxL+9wXe6#|7hJf60Bir}(+I=64zwmx>p7@tXf( zVy^i;gtz>>cSqoH!c-th_*URa!o7e>XbCV{&;m9bzVP%v*x1Nl)Eb#1&h^WQO({T7d;jSvem%@CIR3OCm z!zS|DBI1ih_@Wz;Ny0B9Q-r1{XL#%PsNa6L?EqhOE1Dwqj3TkGPniT0k65{nb2&I9 zh_hoMO5wCu>BmeGIz^v2VXwmbpHTvO!aZdGl^i@k;SJ@aIFi`;nAUho4HIJtO6+~r zPTp1W?x@4$8DddFzUKMZL*%^@^AcW<`A9}T#h{hUz45<+%+K-39+J*T_Q;>Z!^m~cB2Li*mO2IzR}DL4*Qd^-gs6WmRKL#wi}8))OpVMkgV$z&AKr9{EMMC3-qeoNUR+0C3iC`MxtS5?E)*4qt(ii diff --git a/ChimeraTK-DeviceAccess-PythonBindings/head/html/deviceaccess.html b/ChimeraTK-DeviceAccess-PythonBindings/head/html/deviceaccess.html index 4d576785bda..02d553cc069 100644 --- a/ChimeraTK-DeviceAccess-PythonBindings/head/html/deviceaccess.html +++ b/ChimeraTK-DeviceAccess-PythonBindings/head/html/deviceaccess.html @@ -130,7 +130,7 @@
-getOneDRegisterAccessor(userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a8948d30>]] = None) → deviceaccess.OneDRegisterAccessor[source]
+getOneDRegisterAccessor(userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f3b12d6ad00>]] = None) → deviceaccess.OneDRegisterAccessor[source]

Get a OneDRegisterAccessor object for the given register.

The OneDRegisterAccessor allows to read and write registers transparently by using the accessor object like a vector of the type UserType. If needed, the conversion @@ -198,13 +198,13 @@

-getRegisterCatalogue() → <sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a74995b0>[source]
+getRegisterCatalogue() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f3b118ba580>[source]

Return the register catalogue with detailed information on all registers.

-getScalarRegisterAccessor(userType, registerPathName: str, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a8948d30>]] = None) → deviceaccess.ScalarRegisterAccessor[source]
+getScalarRegisterAccessor(userType, registerPathName: str, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f3b12d6ad00>]] = None) → deviceaccess.ScalarRegisterAccessor[source]

Get a ScalarRegisterAccessor object for the given register.

The ScalarRegisterObject allows to read and write registers transparently by using the accessor object like a variable of the type UserType. If needed, the conversion @@ -252,7 +252,7 @@

-getTwoDRegisterAccessor(userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a8948d30>]] = None) → deviceaccess.TwoDRegisterAccessor[source]
+getTwoDRegisterAccessor(userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f3b12d6ad00>]] = None) → deviceaccess.TwoDRegisterAccessor[source]

Get a TwoDRegisterAccessor object for the given register.

This allows to read and write transparently 2-dimensional registers. The optional arguments allow to restrict the accessor to a region of @@ -322,7 +322,7 @@

-getVoidRegisterAccessor(registerPathName: str, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a8948d30>]] = None) → deviceaccess.VoidRegisterAccessor[source]
+getVoidRegisterAccessor(registerPathName: str, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f3b12d6ad00>]] = None) → deviceaccess.VoidRegisterAccessor[source]

Get a VoidRegisterAccessor object for the given register.

The VoidRegisterAccessor allows to read and write registers. Getting a read accessor is only possible with the wait_for_new_data flag. This access mode @@ -502,14 +502,14 @@

-dataValidity() → <sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a8948760>[source]
+dataValidity() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f3b12d6a730>[source]

Return current validity of the data.

Will always return DataValidity.ok if the backend does not support it

-getAccessModeFlags() → Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a8948d30>][source]
+getAccessModeFlags() → Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f3b12d6ad00>][source]

Returns the access modes flags, that were given at the initialization of the accessor.

Examples

@@ -551,7 +551,7 @@
-getId() → <sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a897b640>[source]
+getId() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f3b12d9c610>[source]

Obtain unique ID for the actual implementation of this TransferElement.

This means that e.g. two instances of ScalarRegisterAccessor created by the same call to Device.getScalarRegisterAccessor() @@ -638,7 +638,7 @@

-getVersionNumber() → <sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a7883070>[source]
+getVersionNumber() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f3b11ca4f10>[source]

Returns the version number that is associated with the last transfer (i.e. last read or write). See VersionNumber for details.

Examples

@@ -869,7 +869,7 @@
-class deviceaccess.NumpyGeneralRegisterAccessor(channels, elementsPerChannel, userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a8948d30>]] = None)[source]
+class deviceaccess.NumpyGeneralRegisterAccessor(channels, elementsPerChannel, userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f3b12d6ad00>]] = None)[source]

Bases: deviceaccess.GeneralRegisterAccessor

@@ -1029,7 +1029,7 @@
-class deviceaccess.OneDRegisterAccessor(userType, accessor, accessModeFlags: Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a8948d30>])[source]
+class deviceaccess.OneDRegisterAccessor(userType, accessor, accessModeFlags: Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f3b12d6ad00>])[source]

Bases: deviceaccess.NumpyGeneralRegisterAccessor

Accessor class to read and write registers transparently by using the accessor object like a vector of the type UserType.

@@ -1057,7 +1057,7 @@
-class deviceaccess.ScalarRegisterAccessor(userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a8948d30>]] = None)[source]
+class deviceaccess.ScalarRegisterAccessor(userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f3b12d6ad00>]] = None)[source]

Bases: deviceaccess.NumpyGeneralRegisterAccessor

Accessor class to read and write scalar registers transparently by using the accessor object like a vector of the type UserType.

@@ -1098,7 +1098,7 @@
-setAndWrite(newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a7883070>] = None) → None[source]
+setAndWrite(newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7f3b11ca4f10>] = None) → None[source]

Convenience function to set and write new value.

@@ -1131,7 +1131,7 @@
-writeIfDifferent(newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a7883070>] = None, validity: <sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a8948760> = <sphinx.ext.autodoc.importer._MockObject object>) → None[source]
+writeIfDifferent(newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7f3b11ca4f10>] = None, validity: <sphinx.ext.autodoc.importer._MockObject object at 0x7f3b12d6a730> = <sphinx.ext.autodoc.importer._MockObject object>) → None[source]

Convenience function to set and write new value if it differes from the current value.

The given version number is only used in case the value differs.

@@ -1166,7 +1166,7 @@
-class deviceaccess.TwoDRegisterAccessor(userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7fb3a8948d30>]] = None)[source]
+class deviceaccess.TwoDRegisterAccessor(userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f3b12d6ad00>]] = None)[source]

Bases: deviceaccess.NumpyGeneralRegisterAccessor

Accessor class to read and write registers transparently by using the accessor object like a 2D array of the type UserType.

diff --git a/ChimeraTK-DeviceAccess-PythonBindings/head/html/searchindex.js b/ChimeraTK-DeviceAccess-PythonBindings/head/html/searchindex.js index 26a176e6958..5082ecedc3c 100644 --- a/ChimeraTK-DeviceAccess-PythonBindings/head/html/searchindex.js +++ b/ChimeraTK-DeviceAccess-PythonBindings/head/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["deviceaccess","index","mtca4u"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["deviceaccess.rst","index.rst","mtca4u.rst"],objects:{"":{deviceaccess:[0,0,0,"-"],mtca4u:[2,0,0,"-"]},"deviceaccess.Device":{activateAsyncRead:[0,2,1,""],close:[0,2,1,""],getCatalogueMetadata:[0,2,1,""],getOneDRegisterAccessor:[0,2,1,""],getRegisterCatalogue:[0,2,1,""],getScalarRegisterAccessor:[0,2,1,""],getTwoDRegisterAccessor:[0,2,1,""],getVoidRegisterAccessor:[0,2,1,""],open:[0,2,1,""],read:[0,2,1,""],write:[0,2,1,""]},"deviceaccess.GeneralRegisterAccessor":{dataValidity:[0,2,1,""],getAccessModeFlags:[0,2,1,""],getDescription:[0,2,1,""],getId:[0,2,1,""],getName:[0,2,1,""],getUnit:[0,2,1,""],getValueType:[0,2,1,""],getVersionNumber:[0,2,1,""],interrupt:[0,2,1,""],isInitialised:[0,2,1,""],isReadOnly:[0,2,1,""],isReadable:[0,2,1,""],isWriteable:[0,2,1,""],read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],setDataValidity:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.NumpyGeneralRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],set:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.OneDRegisterAccessor":{getNElements:[0,2,1,""]},"deviceaccess.ScalarRegisterAccessor":{readAndGet:[0,2,1,""],setAndWrite:[0,2,1,""],writeIfDifferent:[0,2,1,""]},"deviceaccess.TwoDRegisterAccessor":{getNChannels:[0,2,1,""],getNElementsPerChannel:[0,2,1,""]},"deviceaccess.VoidRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"mtca4u.Device":{getCatalogueMetadata:[2,2,1,""],read:[2,2,1,""],read_dma_raw:[2,2,1,""],read_raw:[2,2,1,""],read_sequences:[2,2,1,""],write:[2,2,1,""],write_raw:[2,2,1,""]},deviceaccess:{Device:[0,1,1,""],GeneralRegisterAccessor:[0,1,1,""],NumpyGeneralRegisterAccessor:[0,1,1,""],OneDRegisterAccessor:[0,1,1,""],ScalarRegisterAccessor:[0,1,1,""],TwoDRegisterAccessor:[0,1,1,""],VoidRegisterAccessor:[0,1,1,""],getDMapFilePath:[0,3,1,""],setDMapFilePath:[0,3,1,""]},mtca4u:{Device:[2,1,1,""],get_dmap_location:[2,3,1,""],get_info:[2,3,1,""],set_dmap_location:[2,3,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"0x7f5298a8f400":0,"0x7f52b5f8a740":0,"0x7fb3a74995b0":0,"0x7fb3a7883070":0,"0x7fb3a8948760":0,"0x7fb3a8948d30":0,"0x7fb3a897b640":0,"2darrayofvalu":2,"abstract":0,"boolean":0,"case":0,"class":[0,2],"default":[0,2],"float":[0,2],"function":0,"import":[0,2],"int":[0,2],"long":[0,2],"new":[0,2],"return":[0,2],"short":0,"super":0,"throw":0,"true":[0,2],"try":0,"void":0,"while":0,One:0,The:[0,2],There:0,Use:2,Will:0,_da_python_bind:0,_datatowrit:2,_io:2,_mockobject:0,abc:0,about:2,abov:0,absolut:0,acc:0,access:0,accessmod:0,accessmodeflag:0,accessor:0,action:0,activ:0,activateasyncread:0,actual:0,adc0_valu:2,adc1_valu:2,adc3_valu:2,adc:0,after:0,again:2,against:2,alia:[0,2],aliasnam:0,all:[0,2],allow:0,alreadi:0,also:[0,2],alwai:0,ani:0,appli:2,applic:[0,2],arbitari:2,area:2,area_dma_via_dma:2,area_multiplexed_sequence_dma:2,arg:2,argument:0,arr1to10:0,arrai:[0,2],arrayofrawvalu:2,arriv:0,associ:0,assum:2,asynchron:0,attribut:0,autodoc:0,avail:[0,2],avoid:0,awar:2,backend:[0,2],base:[0,2],been:0,befor:0,begin:0,behaviour:0,belong:2,below:0,between:0,binari:2,bit:[0,2],block:[0,2],board:[0,2],boardwithmodul:2,bool:0,both:2,buffer:0,call:0,can:[0,2],card:2,card_with_modul:0,catalogu:[0,2],chang:0,channel:0,check:[0,2],chimeratk:[0,2],client:0,close:0,code:0,column:2,combin:0,come:2,commenc:2,common:0,compat:0,complet:0,concern:0,connect:0,construct:[0,2],constructor:[0,2],contain:[0,2],content:[0,1],contentthat:0,control:0,conveni:0,convent:0,convers:[0,2],convert:[0,2],copi:[0,2],correspond:2,coulum:2,creat:[0,2],creation:0,current:[0,2],data:[0,2],datatowrit:[0,2],datatyp:2,datavalid:0,dda:0,deactiv:0,deciv:2,defin:[0,2],demultiplex:2,depend:[0,2],deprec:2,descript:0,desir:2,destroi:0,detail:[0,2],dev:0,devic:[0,2],device_nam:2,deviceaccess:[1,2],deviceaccess_vers:2,deviceexcept:0,deviceinform:0,differ:0,dimension:[0,2],direct:2,directori:0,discard:0,dma:[0,2],dmap:[0,2],dmap_path:0,dmapfileloc:2,dmapfilepath:0,dmappath:2,dmaregisternam:2,document:0,doe:0,doubl:[0,2],dtype:[0,2],due:0,dummy_interrupt_2:0,duplic:0,dure:0,each:[0,2],effect:0,either:2,element:[0,2],elementindexinregist:[0,2],elementsoffset:0,elementsperchannel:0,elemnt:2,empti:2,enabl:0,encod:2,engin:0,equal:2,error:0,even:0,everi:[0,2],exampl:[0,2],examplecr:0,exce:[0,2],except:0,exist:0,expect:[0,2],ext:0,extract:2,fals:0,faulti:0,fetch:2,file:[0,2],first:[0,2],fit:2,fix:[0,2],flag:0,float32:[0,2],float64:[0,2],form:2,found:0,fraction:2,framework:0,free:0,from:[0,2],generalregisteraccessor:0,get:[0,2],get_dmap_loc:2,get_info:2,getaccessmodeflag:0,getcataloguemetadata:[0,2],getdescript:0,getdmapfilepath:0,getid:0,getnam:0,getnchannel:0,getnel:0,getnelementsperchannel:0,getonedregisteraccessor:0,getregistercatalogu:0,getscalarregisteraccessor:0,gettwodregisteraccessor:0,getunit:0,getvaluetyp:0,getversionnumb:0,getvoidregisteraccessor:0,github:0,give:0,given:[0,2],guarante:0,handl:0,happen:0,hardwar:[0,2],has:[0,2],have:[0,2],henc:0,hold:2,ident:0,identifi:0,ignor:[0,2],immedi:0,implement:0,includ:[0,2],index:[0,1,2],indic:0,individu:2,induvidu:2,ineffici:0,inform:[0,2],inherit:0,initi:0,input:[0,2],instanc:0,instead:2,int16:0,int32:[0,2],int64:0,int8:0,integ:0,intend:2,interest:0,interfac:0,intern:[0,2],interrupt:0,interruptacc:0,isinitialis:0,isread:0,isreadonli:0,iswrit:0,its:[0,2],just:0,kept:0,last:[0,2],latest:0,lead:0,left:0,length:2,librari:[0,2],lifetim:2,like:0,link:2,list:[0,2],locat:[0,2],lock:0,look:[0,2],lookup:[0,2],lost:0,made:2,mai:[0,2],make:2,map:[0,2],mapfil:2,mapfile_revis:0,mapp:0,match:0,mathemat:0,matrix:2,maximm:0,mean:0,memori:2,metadata:[0,2],metadatavalu:2,metatag:0,method:[0,2],might:0,minu:0,mismatch:0,mode:[0,2],modul:1,module1:[0,2],modulenam:2,more:0,mtca4upi:2,multiplex:2,must:0,my_card:2,my_example_dmap_fil:2,name:[0,2],ndarrai:0,need:0,never:0,newvalu:0,next:0,non:0,none:[0,2],not_impl:0,now:0,number:[0,2],numberofchannel:0,numberofel:0,numberofelementstoread:2,numberofword:0,numericaddressedbackend:2,numpi:[0,2],numpygeneralregisteraccessor:0,object:[0,2],obtain:[0,2],offer:0,offset:[0,2],old:0,omit:0,ommit:2,onc:2,oneacc:0,onedregisteraccessor:0,onli:[0,2],open:[0,2],oper:0,operand:0,option:[0,2],origin:0,originacc:0,other:0,otheracc:0,otherwis:0,out:[0,2],outputstream:2,over:2,overflow:0,page:1,paramet:[0,2],parameternam:2,pars:0,part:2,pass:0,passes:2,path:[0,2],per:0,persist:0,place:0,placehold:0,pleas:0,point:[0,2],pointer:0,posit:[0,2],possibl:0,preced:2,present:0,previous:0,print:[0,2],process:0,processarrai:0,program:2,project:0,properli:0,provid:[0,2],purpos:2,push:0,put:2,python:0,queri:2,queue:0,quickli:0,rais:0,rang:0,raw:[0,2],read:[0,2],read__raw:2,read_dma_raw:2,read_raw:2,read_sequ:2,readabl:0,readacc:0,readandget:0,readinrawvalu:2,readlatest:0,readnonblock:0,readonli:0,readoutvalu:2,receiv:0,refer:0,reg_valu:0,region:[0,2],regionnam:2,regist:[0,2],registernam:2,registerpath:[0,2],registerpathnam:0,reject:0,rel:0,repres:2,represent:[0,2],representaion:2,requir:0,resp:0,respect:0,restrict:0,result:0,resultacc:0,right:0,same:[0,2],sampl:0,scalar:0,scalarregisteraccessor:0,scalarregisterobject:0,search:1,second:0,see:0,select:[0,2],send:0,sequenc:[0,2],set:[0,2],set_dmap_loc:2,setandwrit:0,setdatavalid:0,setdmapfilepath:0,shallow:0,shape:0,share:0,shared_raw_devic:0,should:[0,2],sign:0,simimlar:0,sinc:[0,2],singl:2,size:[0,2],slice:0,slicedacc:0,sourc:[0,2],specifi:[0,2],sphinx:0,start:[0,2],statement:0,statu:0,stdout:2,still:0,storag:0,str:[0,2],string:[0,2],suppli:0,support:0,sys:2,system:0,tag:0,take:[0,2],termin:0,test_area:0,test_area_push:0,textiowrapp:2,thei:0,thi:[0,2],though:0,thread:0,through:2,time:0,touch:0,transfer:0,transferel:0,transferelementid:0,transpar:0,trigger:0,two:0,twodregisteraccessor:0,type:[0,2],uint16:0,uint32:0,uint64:0,uint8:0,unbuff:0,undefin:0,understood:0,union:0,uniqu:0,unit:0,unsign:0,until:[0,2],updat:0,uppercas:0,upto:[0,2],usag:0,use:2,used:[0,2],user:[0,2],usertyp:0,uses:[0,2],using:[0,2],usual:0,utf:2,v02:2,valid:0,valu:[0,2],variabl:0,vaue:2,vector:0,veri:0,version:0,versionmnumb:0,versionnumb:0,view:2,voidregisteraccessor:0,wai:2,wait:0,wait_for_new_data:0,well:[0,2],were:0,when:[0,2],where:0,whether:0,which:[0,2],whole:2,width:[0,2],within:2,without:[0,2],word_clk_cnt:0,word_clk_cnt_1:0,word_clk_mux:[0,2],word_statu:[0,2],wordoffsetinregist:0,would:[0,2],write:[0,2],write_raw:2,writeabl:0,writeacc:0,writeaccreg:0,writedestruct:0,writeifdiffer:0,written:[0,2],you:0,zero:[0,2]},titles:["deviceaccess module","mtca4u Python Bindings Doucmentation","mtca4u module"],titleterms:{bind:1,deviceaccess:0,doucment:1,indic:1,modul:[0,2],mtca4u:[1,2],python:1,tabl:1}}) \ No newline at end of file +Search.setIndex({docnames:["deviceaccess","index","mtca4u"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["deviceaccess.rst","index.rst","mtca4u.rst"],objects:{"":{deviceaccess:[0,0,0,"-"],mtca4u:[2,0,0,"-"]},"deviceaccess.Device":{activateAsyncRead:[0,2,1,""],close:[0,2,1,""],getCatalogueMetadata:[0,2,1,""],getOneDRegisterAccessor:[0,2,1,""],getRegisterCatalogue:[0,2,1,""],getScalarRegisterAccessor:[0,2,1,""],getTwoDRegisterAccessor:[0,2,1,""],getVoidRegisterAccessor:[0,2,1,""],open:[0,2,1,""],read:[0,2,1,""],write:[0,2,1,""]},"deviceaccess.GeneralRegisterAccessor":{dataValidity:[0,2,1,""],getAccessModeFlags:[0,2,1,""],getDescription:[0,2,1,""],getId:[0,2,1,""],getName:[0,2,1,""],getUnit:[0,2,1,""],getValueType:[0,2,1,""],getVersionNumber:[0,2,1,""],interrupt:[0,2,1,""],isInitialised:[0,2,1,""],isReadOnly:[0,2,1,""],isReadable:[0,2,1,""],isWriteable:[0,2,1,""],read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],setDataValidity:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.NumpyGeneralRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],set:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.OneDRegisterAccessor":{getNElements:[0,2,1,""]},"deviceaccess.ScalarRegisterAccessor":{readAndGet:[0,2,1,""],setAndWrite:[0,2,1,""],writeIfDifferent:[0,2,1,""]},"deviceaccess.TwoDRegisterAccessor":{getNChannels:[0,2,1,""],getNElementsPerChannel:[0,2,1,""]},"deviceaccess.VoidRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"mtca4u.Device":{getCatalogueMetadata:[2,2,1,""],read:[2,2,1,""],read_dma_raw:[2,2,1,""],read_raw:[2,2,1,""],read_sequences:[2,2,1,""],write:[2,2,1,""],write_raw:[2,2,1,""]},deviceaccess:{Device:[0,1,1,""],GeneralRegisterAccessor:[0,1,1,""],NumpyGeneralRegisterAccessor:[0,1,1,""],OneDRegisterAccessor:[0,1,1,""],ScalarRegisterAccessor:[0,1,1,""],TwoDRegisterAccessor:[0,1,1,""],VoidRegisterAccessor:[0,1,1,""],getDMapFilePath:[0,3,1,""],setDMapFilePath:[0,3,1,""]},mtca4u:{Device:[2,1,1,""],get_dmap_location:[2,3,1,""],get_info:[2,3,1,""],set_dmap_location:[2,3,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"0x7f3b118ba580":0,"0x7f3b11ca4f10":0,"0x7f3b12d6a730":0,"0x7f3b12d6ad00":0,"0x7f3b12d9c610":0,"0x7f5298a8f400":0,"0x7f52b5f8a740":0,"2darrayofvalu":2,"abstract":0,"boolean":0,"case":0,"class":[0,2],"default":[0,2],"float":[0,2],"function":0,"import":[0,2],"int":[0,2],"long":[0,2],"new":[0,2],"return":[0,2],"short":0,"super":0,"throw":0,"true":[0,2],"try":0,"void":0,"while":0,One:0,The:[0,2],There:0,Use:2,Will:0,_da_python_bind:0,_datatowrit:2,_io:2,_mockobject:0,abc:0,about:2,abov:0,absolut:0,acc:0,access:0,accessmod:0,accessmodeflag:0,accessor:0,action:0,activ:0,activateasyncread:0,actual:0,adc0_valu:2,adc1_valu:2,adc3_valu:2,adc:0,after:0,again:2,against:2,alia:[0,2],aliasnam:0,all:[0,2],allow:0,alreadi:0,also:[0,2],alwai:0,ani:0,appli:2,applic:[0,2],arbitari:2,area:2,area_dma_via_dma:2,area_multiplexed_sequence_dma:2,arg:2,argument:0,arr1to10:0,arrai:[0,2],arrayofrawvalu:2,arriv:0,associ:0,assum:2,asynchron:0,attribut:0,autodoc:0,avail:[0,2],avoid:0,awar:2,backend:[0,2],base:[0,2],been:0,befor:0,begin:0,behaviour:0,belong:2,below:0,between:0,binari:2,bit:[0,2],block:[0,2],board:[0,2],boardwithmodul:2,bool:0,both:2,buffer:0,call:0,can:[0,2],card:2,card_with_modul:0,catalogu:[0,2],chang:0,channel:0,check:[0,2],chimeratk:[0,2],client:0,close:0,code:0,column:2,combin:0,come:2,commenc:2,common:0,compat:0,complet:0,concern:0,connect:0,construct:[0,2],constructor:[0,2],contain:[0,2],content:[0,1],contentthat:0,control:0,conveni:0,convent:0,convers:[0,2],convert:[0,2],copi:[0,2],correspond:2,coulum:2,creat:[0,2],creation:0,current:[0,2],data:[0,2],datatowrit:[0,2],datatyp:2,datavalid:0,dda:0,deactiv:0,deciv:2,defin:[0,2],demultiplex:2,depend:[0,2],deprec:2,descript:0,desir:2,destroi:0,detail:[0,2],dev:0,devic:[0,2],device_nam:2,deviceaccess:[1,2],deviceaccess_vers:2,deviceexcept:0,deviceinform:0,differ:0,dimension:[0,2],direct:2,directori:0,discard:0,dma:[0,2],dmap:[0,2],dmap_path:0,dmapfileloc:2,dmapfilepath:0,dmappath:2,dmaregisternam:2,document:0,doe:0,doubl:[0,2],dtype:[0,2],due:0,dummy_interrupt_2:0,duplic:0,dure:0,each:[0,2],effect:0,either:2,element:[0,2],elementindexinregist:[0,2],elementsoffset:0,elementsperchannel:0,elemnt:2,empti:2,enabl:0,encod:2,engin:0,equal:2,error:0,even:0,everi:[0,2],exampl:[0,2],examplecr:0,exce:[0,2],except:0,exist:0,expect:[0,2],ext:0,extract:2,fals:0,faulti:0,fetch:2,file:[0,2],first:[0,2],fit:2,fix:[0,2],flag:0,float32:[0,2],float64:[0,2],form:2,found:0,fraction:2,framework:0,free:0,from:[0,2],generalregisteraccessor:0,get:[0,2],get_dmap_loc:2,get_info:2,getaccessmodeflag:0,getcataloguemetadata:[0,2],getdescript:0,getdmapfilepath:0,getid:0,getnam:0,getnchannel:0,getnel:0,getnelementsperchannel:0,getonedregisteraccessor:0,getregistercatalogu:0,getscalarregisteraccessor:0,gettwodregisteraccessor:0,getunit:0,getvaluetyp:0,getversionnumb:0,getvoidregisteraccessor:0,github:0,give:0,given:[0,2],guarante:0,handl:0,happen:0,hardwar:[0,2],has:[0,2],have:[0,2],henc:0,hold:2,ident:0,identifi:0,ignor:[0,2],immedi:0,implement:0,includ:[0,2],index:[0,1,2],indic:0,individu:2,induvidu:2,ineffici:0,inform:[0,2],inherit:0,initi:0,input:[0,2],instanc:0,instead:2,int16:0,int32:[0,2],int64:0,int8:0,integ:0,intend:2,interest:0,interfac:0,intern:[0,2],interrupt:0,interruptacc:0,isinitialis:0,isread:0,isreadonli:0,iswrit:0,its:[0,2],just:0,kept:0,last:[0,2],latest:0,lead:0,left:0,length:2,librari:[0,2],lifetim:2,like:0,link:2,list:[0,2],locat:[0,2],lock:0,look:[0,2],lookup:[0,2],lost:0,made:2,mai:[0,2],make:2,map:[0,2],mapfil:2,mapfile_revis:0,mapp:0,match:0,mathemat:0,matrix:2,maximm:0,mean:0,memori:2,metadata:[0,2],metadatavalu:2,metatag:0,method:[0,2],might:0,minu:0,mismatch:0,mode:[0,2],modul:1,module1:[0,2],modulenam:2,more:0,mtca4upi:2,multiplex:2,must:0,my_card:2,my_example_dmap_fil:2,name:[0,2],ndarrai:0,need:0,never:0,newvalu:0,next:0,non:0,none:[0,2],not_impl:0,now:0,number:[0,2],numberofchannel:0,numberofel:0,numberofelementstoread:2,numberofword:0,numericaddressedbackend:2,numpi:[0,2],numpygeneralregisteraccessor:0,object:[0,2],obtain:[0,2],offer:0,offset:[0,2],old:0,omit:0,ommit:2,onc:2,oneacc:0,onedregisteraccessor:0,onli:[0,2],open:[0,2],oper:0,operand:0,option:[0,2],origin:0,originacc:0,other:0,otheracc:0,otherwis:0,out:[0,2],outputstream:2,over:2,overflow:0,page:1,paramet:[0,2],parameternam:2,pars:0,part:2,pass:0,passes:2,path:[0,2],per:0,persist:0,place:0,placehold:0,pleas:0,point:[0,2],pointer:0,posit:[0,2],possibl:0,preced:2,present:0,previous:0,print:[0,2],process:0,processarrai:0,program:2,project:0,properli:0,provid:[0,2],purpos:2,push:0,put:2,python:0,queri:2,queue:0,quickli:0,rais:0,rang:0,raw:[0,2],read:[0,2],read__raw:2,read_dma_raw:2,read_raw:2,read_sequ:2,readabl:0,readacc:0,readandget:0,readinrawvalu:2,readlatest:0,readnonblock:0,readonli:0,readoutvalu:2,receiv:0,refer:0,reg_valu:0,region:[0,2],regionnam:2,regist:[0,2],registernam:2,registerpath:[0,2],registerpathnam:0,reject:0,rel:0,repres:2,represent:[0,2],representaion:2,requir:0,resp:0,respect:0,restrict:0,result:0,resultacc:0,right:0,same:[0,2],sampl:0,scalar:0,scalarregisteraccessor:0,scalarregisterobject:0,search:1,second:0,see:0,select:[0,2],send:0,sequenc:[0,2],set:[0,2],set_dmap_loc:2,setandwrit:0,setdatavalid:0,setdmapfilepath:0,shallow:0,shape:0,share:0,shared_raw_devic:0,should:[0,2],sign:0,simimlar:0,sinc:[0,2],singl:2,size:[0,2],slice:0,slicedacc:0,sourc:[0,2],specifi:[0,2],sphinx:0,start:[0,2],statement:0,statu:0,stdout:2,still:0,storag:0,str:[0,2],string:[0,2],suppli:0,support:0,sys:2,system:0,tag:0,take:[0,2],termin:0,test_area:0,test_area_push:0,textiowrapp:2,thei:0,thi:[0,2],though:0,thread:0,through:2,time:0,touch:0,transfer:0,transferel:0,transferelementid:0,transpar:0,trigger:0,two:0,twodregisteraccessor:0,type:[0,2],uint16:0,uint32:0,uint64:0,uint8:0,unbuff:0,undefin:0,understood:0,union:0,uniqu:0,unit:0,unsign:0,until:[0,2],updat:0,uppercas:0,upto:[0,2],usag:0,use:2,used:[0,2],user:[0,2],usertyp:0,uses:[0,2],using:[0,2],usual:0,utf:2,v02:2,valid:0,valu:[0,2],variabl:0,vaue:2,vector:0,veri:0,version:0,versionmnumb:0,versionnumb:0,view:2,voidregisteraccessor:0,wai:2,wait:0,wait_for_new_data:0,well:[0,2],were:0,when:[0,2],where:0,whether:0,which:[0,2],whole:2,width:[0,2],within:2,without:[0,2],word_clk_cnt:0,word_clk_cnt_1:0,word_clk_mux:[0,2],word_statu:[0,2],wordoffsetinregist:0,would:[0,2],write:[0,2],write_raw:2,writeabl:0,writeacc:0,writeaccreg:0,writedestruct:0,writeifdiffer:0,written:[0,2],you:0,zero:[0,2]},titles:["deviceaccess module","mtca4u Python Bindings Doucmentation","mtca4u module"],titleterms:{bind:1,deviceaccess:0,doucment:1,indic:1,modul:[0,2],mtca4u:[1,2],python:1,tabl:1}}) \ No newline at end of file diff --git a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/.doctrees/deviceaccess.doctree b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/.doctrees/deviceaccess.doctree index 151486585e5f81ec535821f18aceb1b0819ed072..91283e0f256575716fcf5cfa6f51ce17cde7968f 100644 GIT binary patch delta 1129 zcmbRFTwvyNfenXzIn7foEeui(Q!FPZo|K)w-;7ygviy10>8p4c1ty31fH)kRb^W$5 zA}MS*?Ydb%K!piOX#MOw9=J&ccCphBrZ9?cej8+B3sPj3Y;0&|xLIq$Ca^IO?(~&A z8J&=14JI|PBAEzs&HE5$F_>$3HvgTzAKevPv*sWRVRwbY90^^7!J89LiXpjtbHnLO zB<^JFMl_#$0rm(|NS(g{390SCkXnT7h=$WLlXC)`r*Gk7oPn?wyTRL^@iR_tf~hi3 z-rh8caW&j9^JI7!fh-0}H%?((#ST-RV!7R94&!k~QRIN1lEEH3B}25wXYxXS2PBn| z^B7l1g87DqMrMiIxppv4gIEOSBP@bQf7!{{Y6VhmZeW;bkg~n$3*&aMatI%;94g)W zjWK>5!nWzJr!hNiH($y$4LN8VPRnlpyqt**Sqy7%Z=bx1$+nyq*;|^^1G5>;whJpU zha+j9UaZ1giDd0p73M+&cYD4n^IZu9AL6R%cFbu=Mob1K=IP#!%>NMTa75K(C+1E$ zZg`Lw*iDy9WK`NdGm*K15m|WhTYt&vrpe5gKqf+iOCW_g30Vy|du*SQ!dxnfq{_X9 z8J-`3aX+_)*>wBdD&~dA0gtL?J5Y@TvNTqUraRR!*Teh=G1zK4OFgqIs+igIoEj#+ f?bGU+eZ*lhz%&Mo%SGq`c6%lf0aiSlS#1UYxOr&O delta 1129 zcmbRFTwvyNfenXzISrFdjFQaLQj8}jo|K)w-;7ygviy10>8p4c1ty31fH)kRb^W$5 zA}MS*?Ydb%K!piOX#MOw9=J&ccCphBrZ9?cej8+B3sPigmXc(ev{`GyCa^IO?(~&A z8J&=14JI|PBAEzs&HE5$F_>$3HvgTzAKevPv*sWRVRwbY90^^7!J89LiXpjtbHnLO zB<^JFMl_#$0rm(|NS(g{390SCkXnT7h=$WLlXC)`r*Gk7oPn?wyTRL^@iR_tf~hh$ z+uk&ZaW&j9b2E4tfh-0}H%?((#ST-RV!YjC4&!k~QRIN1lEEH3B}25wXYxXS2PBn| z^B7l1LikBZW+vOYb}&wZS_I-FSp=5;vXimZ3Z&dHG1=I_e0$Ru#_eF`5I$TvRJ!*Y zWBfXVZPQ;*V|LnZzLaSia?m!Mmfik&ITIVQ7}nt4K6w?BZ8?7gk~p zN76pMScSO~$=a_f%!LT<_Iy?5yAlXK#8uPnnA4Dqm<&wJ)4d&;{~^@jh^og<%$;)F z@E|d;n=Y5gsI+}%B69^Jvhd`${*u#8lbJ7pOoRrPKnimbvKnyq*ghqNxl|NMm3s{{ zJU;^Cer^r3>Gru*%nOkN9#zeDpc)BeX{;7acdBEqhxrd;u+?;ydS+KtF|+A8HB5Zl er`0q2h{I%nX$%;bi_in?_DmuItavuF+6(}aac*}2 diff --git a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/.doctrees/environment.pickle b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/.doctrees/environment.pickle index e2c078fd3a1698294c75f8997d8d339491cc3db6..c008b13655bbec868d848a4e8e8ffc215932658e 100644 GIT binary patch delta 52 zcmZ3zfqnG`_6?5|6jSrP|2t$=Gcho@JKnsPn(trzCaVh0i<0wdW>(zJtjMUb9RN3t B6T<)i delta 52 zcmZ3zfqnG`_6?5|6a@}%dK#Qn&BVaq?s)T_z~OD2@3X4ly#4d_o0%22Gb=J`YzF{N C1{C7} diff --git a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/deviceaccess.html b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/deviceaccess.html index 76aef2ddb1a..c95dcb032ce 100644 --- a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/deviceaccess.html +++ b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/deviceaccess.html @@ -130,7 +130,7 @@
-getOneDRegisterAccessor(userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f1c42b7fd30>]] = None) → deviceaccess.OneDRegisterAccessor[source]
+getOneDRegisterAccessor(userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f7e980e1d90>]] = None) → deviceaccess.OneDRegisterAccessor[source]

Get a OneDRegisterAccessor object for the given register.

The OneDRegisterAccessor allows to read and write registers transparently by using the accessor object like a vector of the type UserType. If needed, the conversion @@ -198,13 +198,13 @@

-getRegisterCatalogue() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f1c416db5b0>[source]
+getRegisterCatalogue() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f7e96c31610>[source]

Return the register catalogue with detailed information on all registers.

-getScalarRegisterAccessor(userType, registerPathName: str, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f1c42b7fd30>]] = None) → deviceaccess.ScalarRegisterAccessor[source]
+getScalarRegisterAccessor(userType, registerPathName: str, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f7e980e1d90>]] = None) → deviceaccess.ScalarRegisterAccessor[source]

Get a ScalarRegisterAccessor object for the given register.

The ScalarRegisterObject allows to read and write registers transparently by using the accessor object like a variable of the type UserType. If needed, the conversion @@ -252,7 +252,7 @@

-getTwoDRegisterAccessor(userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f1c42b7fd30>]] = None) → deviceaccess.TwoDRegisterAccessor[source]
+getTwoDRegisterAccessor(userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f7e980e1d90>]] = None) → deviceaccess.TwoDRegisterAccessor[source]

Get a TwoDRegisterAccessor object for the given register.

This allows to read and write transparently 2-dimensional registers. The optional arguments allow to restrict the accessor to a region of @@ -322,7 +322,7 @@

-getVoidRegisterAccessor(registerPathName: str, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f1c42b7fd30>]] = None) → deviceaccess.VoidRegisterAccessor[source]
+getVoidRegisterAccessor(registerPathName: str, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f7e980e1d90>]] = None) → deviceaccess.VoidRegisterAccessor[source]

Get a VoidRegisterAccessor object for the given register.

The VoidRegisterAccessor allows to read and write registers. Getting a read accessor is only possible with the wait_for_new_data flag. This access mode @@ -502,14 +502,14 @@

-dataValidity() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f1c42b7f760>[source]
+dataValidity() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f7e980e17c0>[source]

Return current validity of the data.

Will always return DataValidity.ok if the backend does not support it

-getAccessModeFlags() → Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f1c42b7fd30>][source]
+getAccessModeFlags() → Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f7e980e1d90>][source]

Returns the access modes flags, that were given at the initialization of the accessor.

Examples

@@ -551,7 +551,7 @@
-getId() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f1c42bbb640>[source]
+getId() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f7e981126a0>[source]

Obtain unique ID for the actual implementation of this TransferElement.

This means that e.g. two instances of ScalarRegisterAccessor created by the same call to Device.getScalarRegisterAccessor() @@ -638,7 +638,7 @@

-getVersionNumber() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f1c41ac3070>[source]
+getVersionNumber() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f7e9701a0d0>[source]

Returns the version number that is associated with the last transfer (i.e. last read or write). See VersionNumber for details.

Examples

@@ -869,7 +869,7 @@
-class deviceaccess.NumpyGeneralRegisterAccessor(channels, elementsPerChannel, userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f1c42b7fd30>]] = None)[source]
+class deviceaccess.NumpyGeneralRegisterAccessor(channels, elementsPerChannel, userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f7e980e1d90>]] = None)[source]

Bases: deviceaccess.GeneralRegisterAccessor

@@ -1029,7 +1029,7 @@
-class deviceaccess.OneDRegisterAccessor(userType, accessor, accessModeFlags: Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f1c42b7fd30>])[source]
+class deviceaccess.OneDRegisterAccessor(userType, accessor, accessModeFlags: Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f7e980e1d90>])[source]

Bases: deviceaccess.NumpyGeneralRegisterAccessor

Accessor class to read and write registers transparently by using the accessor object like a vector of the type UserType.

@@ -1057,7 +1057,7 @@
-class deviceaccess.ScalarRegisterAccessor(userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f1c42b7fd30>]] = None)[source]
+class deviceaccess.ScalarRegisterAccessor(userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f7e980e1d90>]] = None)[source]

Bases: deviceaccess.NumpyGeneralRegisterAccessor

Accessor class to read and write scalar registers transparently by using the accessor object like a vector of the type UserType.

@@ -1098,7 +1098,7 @@
-setAndWrite(newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7f1c41ac3070>] = None) → None[source]
+setAndWrite(newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7f7e9701a0d0>] = None) → None[source]

Convenience function to set and write new value.

@@ -1131,7 +1131,7 @@
-writeIfDifferent(newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7f1c41ac3070>] = None, validity: <sphinx.ext.autodoc.importer._MockObject object at 0x7f1c42b7f760> = <sphinx.ext.autodoc.importer._MockObject object>) → None[source]
+writeIfDifferent(newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7f7e9701a0d0>] = None, validity: <sphinx.ext.autodoc.importer._MockObject object at 0x7f7e980e17c0> = <sphinx.ext.autodoc.importer._MockObject object>) → None[source]

Convenience function to set and write new value if it differes from the current value.

The given version number is only used in case the value differs.

@@ -1166,7 +1166,7 @@
-class deviceaccess.TwoDRegisterAccessor(userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f1c42b7fd30>]] = None)[source]
+class deviceaccess.TwoDRegisterAccessor(userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f7e980e1d90>]] = None)[source]

Bases: deviceaccess.NumpyGeneralRegisterAccessor

Accessor class to read and write registers transparently by using the accessor object like a 2D array of the type UserType.

diff --git a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/searchindex.js b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/searchindex.js index 1d177f4150b..13b31740d33 100644 --- a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/searchindex.js +++ b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["deviceaccess","index","mtca4u"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["deviceaccess.rst","index.rst","mtca4u.rst"],objects:{"":{deviceaccess:[0,0,0,"-"],mtca4u:[2,0,0,"-"]},"deviceaccess.Device":{activateAsyncRead:[0,2,1,""],close:[0,2,1,""],getCatalogueMetadata:[0,2,1,""],getOneDRegisterAccessor:[0,2,1,""],getRegisterCatalogue:[0,2,1,""],getScalarRegisterAccessor:[0,2,1,""],getTwoDRegisterAccessor:[0,2,1,""],getVoidRegisterAccessor:[0,2,1,""],open:[0,2,1,""],read:[0,2,1,""],write:[0,2,1,""]},"deviceaccess.GeneralRegisterAccessor":{dataValidity:[0,2,1,""],getAccessModeFlags:[0,2,1,""],getDescription:[0,2,1,""],getId:[0,2,1,""],getName:[0,2,1,""],getUnit:[0,2,1,""],getValueType:[0,2,1,""],getVersionNumber:[0,2,1,""],interrupt:[0,2,1,""],isInitialised:[0,2,1,""],isReadOnly:[0,2,1,""],isReadable:[0,2,1,""],isWriteable:[0,2,1,""],read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],setDataValidity:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.NumpyGeneralRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],set:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.OneDRegisterAccessor":{getNElements:[0,2,1,""]},"deviceaccess.ScalarRegisterAccessor":{readAndGet:[0,2,1,""],setAndWrite:[0,2,1,""],writeIfDifferent:[0,2,1,""]},"deviceaccess.TwoDRegisterAccessor":{getNChannels:[0,2,1,""],getNElementsPerChannel:[0,2,1,""]},"deviceaccess.VoidRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"mtca4u.Device":{getCatalogueMetadata:[2,2,1,""],read:[2,2,1,""],read_dma_raw:[2,2,1,""],read_raw:[2,2,1,""],read_sequences:[2,2,1,""],write:[2,2,1,""],write_raw:[2,2,1,""]},deviceaccess:{Device:[0,1,1,""],GeneralRegisterAccessor:[0,1,1,""],NumpyGeneralRegisterAccessor:[0,1,1,""],OneDRegisterAccessor:[0,1,1,""],ScalarRegisterAccessor:[0,1,1,""],TwoDRegisterAccessor:[0,1,1,""],VoidRegisterAccessor:[0,1,1,""],getDMapFilePath:[0,3,1,""],setDMapFilePath:[0,3,1,""]},mtca4u:{Device:[2,1,1,""],get_dmap_location:[2,3,1,""],get_info:[2,3,1,""],set_dmap_location:[2,3,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"0x7f1c416db5b0":0,"0x7f1c41ac3070":0,"0x7f1c42b7f760":0,"0x7f1c42b7fd30":0,"0x7f1c42bbb640":0,"0x7f5298a8f400":0,"0x7f52b5f8a740":0,"2darrayofvalu":2,"abstract":0,"boolean":0,"case":0,"class":[0,2],"default":[0,2],"float":[0,2],"function":0,"import":[0,2],"int":[0,2],"long":[0,2],"new":[0,2],"return":[0,2],"short":0,"super":0,"throw":0,"true":[0,2],"try":0,"void":0,"while":0,One:0,The:[0,2],There:0,Use:2,Will:0,_da_python_bind:0,_datatowrit:2,_io:2,_mockobject:0,abc:0,about:2,abov:0,absolut:0,acc:0,access:0,accessmod:0,accessmodeflag:0,accessor:0,action:0,activ:0,activateasyncread:0,actual:0,adc0_valu:2,adc1_valu:2,adc3_valu:2,adc:0,after:0,again:2,against:2,alia:[0,2],aliasnam:0,all:[0,2],allow:0,alreadi:0,also:[0,2],alwai:0,ani:0,appli:2,applic:[0,2],arbitari:2,area:2,area_dma_via_dma:2,area_multiplexed_sequence_dma:2,arg:2,argument:0,arr1to10:0,arrai:[0,2],arrayofrawvalu:2,arriv:0,associ:0,assum:2,asynchron:0,attribut:0,autodoc:0,avail:[0,2],avoid:0,awar:2,backend:[0,2],base:[0,2],been:0,befor:0,begin:0,behaviour:0,belong:2,below:0,between:0,binari:2,bit:[0,2],block:[0,2],board:[0,2],boardwithmodul:2,bool:0,both:2,buffer:0,call:0,can:[0,2],card:2,card_with_modul:0,catalogu:[0,2],chang:0,channel:0,check:[0,2],chimeratk:[0,2],client:0,close:0,code:0,column:2,combin:0,come:2,commenc:2,common:0,compat:0,complet:0,concern:0,connect:0,construct:[0,2],constructor:[0,2],contain:[0,2],content:[0,1],contentthat:0,control:0,conveni:0,convent:0,convers:[0,2],convert:[0,2],copi:[0,2],correspond:2,coulum:2,creat:[0,2],creation:0,current:[0,2],data:[0,2],datatowrit:[0,2],datatyp:2,datavalid:0,dda:0,deactiv:0,deciv:2,defin:[0,2],demultiplex:2,depend:[0,2],deprec:2,descript:0,desir:2,destroi:0,detail:[0,2],dev:0,devic:[0,2],device_nam:2,deviceaccess:[1,2],deviceaccess_vers:2,deviceexcept:0,deviceinform:0,differ:0,dimension:[0,2],direct:2,directori:0,discard:0,dma:[0,2],dmap:[0,2],dmap_path:0,dmapfileloc:2,dmapfilepath:0,dmappath:2,dmaregisternam:2,document:0,doe:0,doubl:[0,2],dtype:[0,2],due:0,dummy_interrupt_2:0,duplic:0,dure:0,each:[0,2],effect:0,either:2,element:[0,2],elementindexinregist:[0,2],elementsoffset:0,elementsperchannel:0,elemnt:2,empti:2,enabl:0,encod:2,engin:0,equal:2,error:0,even:0,everi:[0,2],exampl:[0,2],examplecr:0,exce:[0,2],except:0,exist:0,expect:[0,2],ext:0,extract:2,fals:0,faulti:0,fetch:2,file:[0,2],first:[0,2],fit:2,fix:[0,2],flag:0,float32:[0,2],float64:[0,2],form:2,found:0,fraction:2,framework:0,free:0,from:[0,2],generalregisteraccessor:0,get:[0,2],get_dmap_loc:2,get_info:2,getaccessmodeflag:0,getcataloguemetadata:[0,2],getdescript:0,getdmapfilepath:0,getid:0,getnam:0,getnchannel:0,getnel:0,getnelementsperchannel:0,getonedregisteraccessor:0,getregistercatalogu:0,getscalarregisteraccessor:0,gettwodregisteraccessor:0,getunit:0,getvaluetyp:0,getversionnumb:0,getvoidregisteraccessor:0,github:0,give:0,given:[0,2],guarante:0,handl:0,happen:0,hardwar:[0,2],has:[0,2],have:[0,2],henc:0,hold:2,ident:0,identifi:0,ignor:[0,2],immedi:0,implement:0,includ:[0,2],index:[0,1,2],indic:0,individu:2,induvidu:2,ineffici:0,inform:[0,2],inherit:0,initi:0,input:[0,2],instanc:0,instead:2,int16:0,int32:[0,2],int64:0,int8:0,integ:0,intend:2,interest:0,interfac:0,intern:[0,2],interrupt:0,interruptacc:0,isinitialis:0,isread:0,isreadonli:0,iswrit:0,its:[0,2],just:0,kept:0,last:[0,2],latest:0,lead:0,left:0,length:2,librari:[0,2],lifetim:2,like:0,link:2,list:[0,2],locat:[0,2],lock:0,look:[0,2],lookup:[0,2],lost:0,made:2,mai:[0,2],make:2,map:[0,2],mapfil:2,mapfile_revis:0,mapp:0,match:0,mathemat:0,matrix:2,maximm:0,mean:0,memori:2,metadata:[0,2],metadatavalu:2,metatag:0,method:[0,2],might:0,minu:0,mismatch:0,mode:[0,2],modul:1,module1:[0,2],modulenam:2,more:0,mtca4upi:2,multiplex:2,must:0,my_card:2,my_example_dmap_fil:2,name:[0,2],ndarrai:0,need:0,never:0,newvalu:0,next:0,non:0,none:[0,2],not_impl:0,now:0,number:[0,2],numberofchannel:0,numberofel:0,numberofelementstoread:2,numberofword:0,numericaddressedbackend:2,numpi:[0,2],numpygeneralregisteraccessor:0,object:[0,2],obtain:[0,2],offer:0,offset:[0,2],old:0,omit:0,ommit:2,onc:2,oneacc:0,onedregisteraccessor:0,onli:[0,2],open:[0,2],oper:0,operand:0,option:[0,2],origin:0,originacc:0,other:0,otheracc:0,otherwis:0,out:[0,2],outputstream:2,over:2,overflow:0,page:1,paramet:[0,2],parameternam:2,pars:0,part:2,pass:0,passes:2,path:[0,2],per:0,persist:0,place:0,placehold:0,pleas:0,point:[0,2],pointer:0,posit:[0,2],possibl:0,preced:2,present:0,previous:0,print:[0,2],process:0,processarrai:0,program:2,project:0,properli:0,provid:[0,2],purpos:2,push:0,put:2,python:0,queri:2,queue:0,quickli:0,rais:0,rang:0,raw:[0,2],read:[0,2],read__raw:2,read_dma_raw:2,read_raw:2,read_sequ:2,readabl:0,readacc:0,readandget:0,readinrawvalu:2,readlatest:0,readnonblock:0,readonli:0,readoutvalu:2,receiv:0,refer:0,reg_valu:0,region:[0,2],regionnam:2,regist:[0,2],registernam:2,registerpath:[0,2],registerpathnam:0,reject:0,rel:0,repres:2,represent:[0,2],representaion:2,requir:0,resp:0,respect:0,restrict:0,result:0,resultacc:0,right:0,same:[0,2],sampl:0,scalar:0,scalarregisteraccessor:0,scalarregisterobject:0,search:1,second:0,see:0,select:[0,2],send:0,sequenc:[0,2],set:[0,2],set_dmap_loc:2,setandwrit:0,setdatavalid:0,setdmapfilepath:0,shallow:0,shape:0,share:0,shared_raw_devic:0,should:[0,2],sign:0,simimlar:0,sinc:[0,2],singl:2,size:[0,2],slice:0,slicedacc:0,sourc:[0,2],specifi:[0,2],sphinx:0,start:[0,2],statement:0,statu:0,stdout:2,still:0,storag:0,str:[0,2],string:[0,2],suppli:0,support:0,sys:2,system:0,tag:0,take:[0,2],termin:0,test_area:0,test_area_push:0,textiowrapp:2,thei:0,thi:[0,2],though:0,thread:0,through:2,time:0,touch:0,transfer:0,transferel:0,transferelementid:0,transpar:0,trigger:0,two:0,twodregisteraccessor:0,type:[0,2],uint16:0,uint32:0,uint64:0,uint8:0,unbuff:0,undefin:0,understood:0,union:0,uniqu:0,unit:0,unsign:0,until:[0,2],updat:0,uppercas:0,upto:[0,2],usag:0,use:2,used:[0,2],user:[0,2],usertyp:0,uses:[0,2],using:[0,2],usual:0,utf:2,v02:2,valid:0,valu:[0,2],variabl:0,vaue:2,vector:0,veri:0,version:0,versionmnumb:0,versionnumb:0,view:2,voidregisteraccessor:0,wai:2,wait:0,wait_for_new_data:0,well:[0,2],were:0,when:[0,2],where:0,whether:0,which:[0,2],whole:2,width:[0,2],within:2,without:[0,2],word_clk_cnt:0,word_clk_cnt_1:0,word_clk_mux:[0,2],word_statu:[0,2],wordoffsetinregist:0,would:[0,2],write:[0,2],write_raw:2,writeabl:0,writeacc:0,writeaccreg:0,writedestruct:0,writeifdiffer:0,written:[0,2],you:0,zero:[0,2]},titles:["deviceaccess module","mtca4u Python Bindings Doucmentation","mtca4u module"],titleterms:{bind:1,deviceaccess:0,doucment:1,indic:1,modul:[0,2],mtca4u:[1,2],python:1,tabl:1}}) \ No newline at end of file +Search.setIndex({docnames:["deviceaccess","index","mtca4u"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["deviceaccess.rst","index.rst","mtca4u.rst"],objects:{"":{deviceaccess:[0,0,0,"-"],mtca4u:[2,0,0,"-"]},"deviceaccess.Device":{activateAsyncRead:[0,2,1,""],close:[0,2,1,""],getCatalogueMetadata:[0,2,1,""],getOneDRegisterAccessor:[0,2,1,""],getRegisterCatalogue:[0,2,1,""],getScalarRegisterAccessor:[0,2,1,""],getTwoDRegisterAccessor:[0,2,1,""],getVoidRegisterAccessor:[0,2,1,""],open:[0,2,1,""],read:[0,2,1,""],write:[0,2,1,""]},"deviceaccess.GeneralRegisterAccessor":{dataValidity:[0,2,1,""],getAccessModeFlags:[0,2,1,""],getDescription:[0,2,1,""],getId:[0,2,1,""],getName:[0,2,1,""],getUnit:[0,2,1,""],getValueType:[0,2,1,""],getVersionNumber:[0,2,1,""],interrupt:[0,2,1,""],isInitialised:[0,2,1,""],isReadOnly:[0,2,1,""],isReadable:[0,2,1,""],isWriteable:[0,2,1,""],read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],setDataValidity:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.NumpyGeneralRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],set:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"deviceaccess.OneDRegisterAccessor":{getNElements:[0,2,1,""]},"deviceaccess.ScalarRegisterAccessor":{readAndGet:[0,2,1,""],setAndWrite:[0,2,1,""],writeIfDifferent:[0,2,1,""]},"deviceaccess.TwoDRegisterAccessor":{getNChannels:[0,2,1,""],getNElementsPerChannel:[0,2,1,""]},"deviceaccess.VoidRegisterAccessor":{read:[0,2,1,""],readLatest:[0,2,1,""],readNonBlocking:[0,2,1,""],write:[0,2,1,""],writeDestructively:[0,2,1,""]},"mtca4u.Device":{getCatalogueMetadata:[2,2,1,""],read:[2,2,1,""],read_dma_raw:[2,2,1,""],read_raw:[2,2,1,""],read_sequences:[2,2,1,""],write:[2,2,1,""],write_raw:[2,2,1,""]},deviceaccess:{Device:[0,1,1,""],GeneralRegisterAccessor:[0,1,1,""],NumpyGeneralRegisterAccessor:[0,1,1,""],OneDRegisterAccessor:[0,1,1,""],ScalarRegisterAccessor:[0,1,1,""],TwoDRegisterAccessor:[0,1,1,""],VoidRegisterAccessor:[0,1,1,""],getDMapFilePath:[0,3,1,""],setDMapFilePath:[0,3,1,""]},mtca4u:{Device:[2,1,1,""],get_dmap_location:[2,3,1,""],get_info:[2,3,1,""],set_dmap_location:[2,3,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"0x7f5298a8f400":0,"0x7f52b5f8a740":0,"0x7f7e96c31610":0,"0x7f7e9701a0d0":0,"0x7f7e980e17c0":0,"0x7f7e980e1d90":0,"0x7f7e981126a0":0,"2darrayofvalu":2,"abstract":0,"boolean":0,"case":0,"class":[0,2],"default":[0,2],"float":[0,2],"function":0,"import":[0,2],"int":[0,2],"long":[0,2],"new":[0,2],"return":[0,2],"short":0,"super":0,"throw":0,"true":[0,2],"try":0,"void":0,"while":0,One:0,The:[0,2],There:0,Use:2,Will:0,_da_python_bind:0,_datatowrit:2,_io:2,_mockobject:0,abc:0,about:2,abov:0,absolut:0,acc:0,access:0,accessmod:0,accessmodeflag:0,accessor:0,action:0,activ:0,activateasyncread:0,actual:0,adc0_valu:2,adc1_valu:2,adc3_valu:2,adc:0,after:0,again:2,against:2,alia:[0,2],aliasnam:0,all:[0,2],allow:0,alreadi:0,also:[0,2],alwai:0,ani:0,appli:2,applic:[0,2],arbitari:2,area:2,area_dma_via_dma:2,area_multiplexed_sequence_dma:2,arg:2,argument:0,arr1to10:0,arrai:[0,2],arrayofrawvalu:2,arriv:0,associ:0,assum:2,asynchron:0,attribut:0,autodoc:0,avail:[0,2],avoid:0,awar:2,backend:[0,2],base:[0,2],been:0,befor:0,begin:0,behaviour:0,belong:2,below:0,between:0,binari:2,bit:[0,2],block:[0,2],board:[0,2],boardwithmodul:2,bool:0,both:2,buffer:0,call:0,can:[0,2],card:2,card_with_modul:0,catalogu:[0,2],chang:0,channel:0,check:[0,2],chimeratk:[0,2],client:0,close:0,code:0,column:2,combin:0,come:2,commenc:2,common:0,compat:0,complet:0,concern:0,connect:0,construct:[0,2],constructor:[0,2],contain:[0,2],content:[0,1],contentthat:0,control:0,conveni:0,convent:0,convers:[0,2],convert:[0,2],copi:[0,2],correspond:2,coulum:2,creat:[0,2],creation:0,current:[0,2],data:[0,2],datatowrit:[0,2],datatyp:2,datavalid:0,dda:0,deactiv:0,deciv:2,defin:[0,2],demultiplex:2,depend:[0,2],deprec:2,descript:0,desir:2,destroi:0,detail:[0,2],dev:0,devic:[0,2],device_nam:2,deviceaccess:[1,2],deviceaccess_vers:2,deviceexcept:0,deviceinform:0,differ:0,dimension:[0,2],direct:2,directori:0,discard:0,dma:[0,2],dmap:[0,2],dmap_path:0,dmapfileloc:2,dmapfilepath:0,dmappath:2,dmaregisternam:2,document:0,doe:0,doubl:[0,2],dtype:[0,2],due:0,dummy_interrupt_2:0,duplic:0,dure:0,each:[0,2],effect:0,either:2,element:[0,2],elementindexinregist:[0,2],elementsoffset:0,elementsperchannel:0,elemnt:2,empti:2,enabl:0,encod:2,engin:0,equal:2,error:0,even:0,everi:[0,2],exampl:[0,2],examplecr:0,exce:[0,2],except:0,exist:0,expect:[0,2],ext:0,extract:2,fals:0,faulti:0,fetch:2,file:[0,2],first:[0,2],fit:2,fix:[0,2],flag:0,float32:[0,2],float64:[0,2],form:2,found:0,fraction:2,framework:0,free:0,from:[0,2],generalregisteraccessor:0,get:[0,2],get_dmap_loc:2,get_info:2,getaccessmodeflag:0,getcataloguemetadata:[0,2],getdescript:0,getdmapfilepath:0,getid:0,getnam:0,getnchannel:0,getnel:0,getnelementsperchannel:0,getonedregisteraccessor:0,getregistercatalogu:0,getscalarregisteraccessor:0,gettwodregisteraccessor:0,getunit:0,getvaluetyp:0,getversionnumb:0,getvoidregisteraccessor:0,github:0,give:0,given:[0,2],guarante:0,handl:0,happen:0,hardwar:[0,2],has:[0,2],have:[0,2],henc:0,hold:2,ident:0,identifi:0,ignor:[0,2],immedi:0,implement:0,includ:[0,2],index:[0,1,2],indic:0,individu:2,induvidu:2,ineffici:0,inform:[0,2],inherit:0,initi:0,input:[0,2],instanc:0,instead:2,int16:0,int32:[0,2],int64:0,int8:0,integ:0,intend:2,interest:0,interfac:0,intern:[0,2],interrupt:0,interruptacc:0,isinitialis:0,isread:0,isreadonli:0,iswrit:0,its:[0,2],just:0,kept:0,last:[0,2],latest:0,lead:0,left:0,length:2,librari:[0,2],lifetim:2,like:0,link:2,list:[0,2],locat:[0,2],lock:0,look:[0,2],lookup:[0,2],lost:0,made:2,mai:[0,2],make:2,map:[0,2],mapfil:2,mapfile_revis:0,mapp:0,match:0,mathemat:0,matrix:2,maximm:0,mean:0,memori:2,metadata:[0,2],metadatavalu:2,metatag:0,method:[0,2],might:0,minu:0,mismatch:0,mode:[0,2],modul:1,module1:[0,2],modulenam:2,more:0,mtca4upi:2,multiplex:2,must:0,my_card:2,my_example_dmap_fil:2,name:[0,2],ndarrai:0,need:0,never:0,newvalu:0,next:0,non:0,none:[0,2],not_impl:0,now:0,number:[0,2],numberofchannel:0,numberofel:0,numberofelementstoread:2,numberofword:0,numericaddressedbackend:2,numpi:[0,2],numpygeneralregisteraccessor:0,object:[0,2],obtain:[0,2],offer:0,offset:[0,2],old:0,omit:0,ommit:2,onc:2,oneacc:0,onedregisteraccessor:0,onli:[0,2],open:[0,2],oper:0,operand:0,option:[0,2],origin:0,originacc:0,other:0,otheracc:0,otherwis:0,out:[0,2],outputstream:2,over:2,overflow:0,page:1,paramet:[0,2],parameternam:2,pars:0,part:2,pass:0,passes:2,path:[0,2],per:0,persist:0,place:0,placehold:0,pleas:0,point:[0,2],pointer:0,posit:[0,2],possibl:0,preced:2,present:0,previous:0,print:[0,2],process:0,processarrai:0,program:2,project:0,properli:0,provid:[0,2],purpos:2,push:0,put:2,python:0,queri:2,queue:0,quickli:0,rais:0,rang:0,raw:[0,2],read:[0,2],read__raw:2,read_dma_raw:2,read_raw:2,read_sequ:2,readabl:0,readacc:0,readandget:0,readinrawvalu:2,readlatest:0,readnonblock:0,readonli:0,readoutvalu:2,receiv:0,refer:0,reg_valu:0,region:[0,2],regionnam:2,regist:[0,2],registernam:2,registerpath:[0,2],registerpathnam:0,reject:0,rel:0,repres:2,represent:[0,2],representaion:2,requir:0,resp:0,respect:0,restrict:0,result:0,resultacc:0,right:0,same:[0,2],sampl:0,scalar:0,scalarregisteraccessor:0,scalarregisterobject:0,search:1,second:0,see:0,select:[0,2],send:0,sequenc:[0,2],set:[0,2],set_dmap_loc:2,setandwrit:0,setdatavalid:0,setdmapfilepath:0,shallow:0,shape:0,share:0,shared_raw_devic:0,should:[0,2],sign:0,simimlar:0,sinc:[0,2],singl:2,size:[0,2],slice:0,slicedacc:0,sourc:[0,2],specifi:[0,2],sphinx:0,start:[0,2],statement:0,statu:0,stdout:2,still:0,storag:0,str:[0,2],string:[0,2],suppli:0,support:0,sys:2,system:0,tag:0,take:[0,2],termin:0,test_area:0,test_area_push:0,textiowrapp:2,thei:0,thi:[0,2],though:0,thread:0,through:2,time:0,touch:0,transfer:0,transferel:0,transferelementid:0,transpar:0,trigger:0,two:0,twodregisteraccessor:0,type:[0,2],uint16:0,uint32:0,uint64:0,uint8:0,unbuff:0,undefin:0,understood:0,union:0,uniqu:0,unit:0,unsign:0,until:[0,2],updat:0,uppercas:0,upto:[0,2],usag:0,use:2,used:[0,2],user:[0,2],usertyp:0,uses:[0,2],using:[0,2],usual:0,utf:2,v02:2,valid:0,valu:[0,2],variabl:0,vaue:2,vector:0,veri:0,version:0,versionmnumb:0,versionnumb:0,view:2,voidregisteraccessor:0,wai:2,wait:0,wait_for_new_data:0,well:[0,2],were:0,when:[0,2],where:0,whether:0,which:[0,2],whole:2,width:[0,2],within:2,without:[0,2],word_clk_cnt:0,word_clk_cnt_1:0,word_clk_mux:[0,2],word_statu:[0,2],wordoffsetinregist:0,would:[0,2],write:[0,2],write_raw:2,writeabl:0,writeacc:0,writeaccreg:0,writedestruct:0,writeifdiffer:0,written:[0,2],you:0,zero:[0,2]},titles:["deviceaccess module","mtca4u Python Bindings Doucmentation","mtca4u module"],titleterms:{bind:1,deviceaccess:0,doucment:1,indic:1,modul:[0,2],mtca4u:[1,2],python:1,tabl:1}}) \ No newline at end of file diff --git a/index.html b/index.html index 2b8c13371b9..e7a3527e639 100644 --- a/index.html +++ b/index.html @@ -242,7 +242,7 @@

ChimeraTK Documentation

- Generated on Sat Jan 4 06:43:13 UTC 2025 in 792 seconds. + Generated on Sun Jan 5 06:40:16 UTC 2025 in 616 seconds.