From 7a82718a572da19819846b8ae8ec4a47c171da60 Mon Sep 17 00:00:00 2001 From: Automated MSK Jenkins User Date: Tue, 14 Jan 2025 06:39:24 +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 d35d3e628af..ff3133ac9ce 100644 --- a/AmtfDbAccess/head/graph_legend.html +++ b/AmtfDbAccess/head/graph_legend.html @@ -129,7 +129,7 @@
-Generated on Fri Jan 10 2025 18:55:38 for AmtfDbAccess library by   +Generated on Mon Jan 13 2025 18:55:27 for AmtfDbAccess library by   doxygen 1.8.17
diff --git a/AmtfDbAccess/head/index.html b/AmtfDbAccess/head/index.html index 7df22239c64..dcd4c558553 100644 --- a/AmtfDbAccess/head/index.html +++ b/AmtfDbAccess/head/index.html @@ -69,7 +69,7 @@
-Generated on Fri Jan 10 2025 18:55:38 for AmtfDbAccess library by   +Generated on Mon Jan 13 2025 18:55:27 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 911c930876f1a0605ad63fc454dda8da8bdf4669..6601ed0a90319516becad988159d801e4bed090c 100644 GIT binary patch delta 1055 zcmeBtDbV>+V8abxPRqnZ3qu3T6ywbgeI=L>-02A`m}EE02lya~O+G(6520dm?>VW> zticwxAR)74Q%lpN&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#z|%-+k+V8abx&SWza3**$Z6wA#IeI=L>-02A`m}EE02lya~O+G(6520dm?>VW> zticwxAR)6f<0RA6&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*GYo;CWfhIiQ9vAFwTG|2lEl8L!|9? zF;2DuDK|GZGBZfre(MY4POx$aAFdoK{rnqa?>Z#gYL_zILJGI-!1SSv#K(-2?Xs(x z!po6OP-32pq+`0IDsv@5dirct=0XH_yQmuTQwaorI?#Tn?XLFB8OTO}5-BKwO#ki3 z{12fRi(@7`Gf$KQsepPX?&|6-}OSPJFvx zDs#CglA?1}%(_E=`FeqgEQ}3UxyUj}^Vt?@Q?6~ra1r)r zx}=$yQ#sbuWb6~Iq&fwEFNgvACyIw4zy3DS(0s(V1aZRpNA!~VZ2(+B9~J<1Q+JJ zoJu4$@o+pEQgf3Rs{SNJrfM=%{XRx%P1ovKRODR-tXAX(0~QV6;Igq!)OF z-pt4nskfYfMKWm-i&)XMi2G1R#v3^N;?AaJ9txQICGLF*okeRM&UwySgScXCMZ9h^ z$V2O?`$l0p8W)3pS=h1ZToYG_w6pkie?W-2iAh&m!JyK8aY<(t$YM(uMeS zyFhOD93c-{3jU+z(2vjZz~il~!dxr6J=K{Se89XfICv~w9fYT!P(r0fW z`)xXuvK^cN4mRioM>pb4M=zqz$t*1Odzf#(E&C7~b=}#A)=^0yU!Ku%OQ)lf$<#j# z1>A71y#-yE*&-dG13i$>^K>E>ODzAWWLF)2lggEe$HX-t_qbZfo0$v_lsyV4uZx`T0 zr9Y!p*%atE!;C`I;sd;9wg@EJR*YiO$6LZ?MWsL`5uKH}>WD^E1jfHCeo)py9_}9m zd-@DTr+S=KWY%d?tjAHTA}hO`%d~O`Diphs&g$SX%c(pB0=BR+1ZKsditd#_DP8RW z^&slFf&9^?A*UoZFbqQlF2Zm+q=7&ePg$;{(9w>5C{^TgWPN#hlw-;hp!bHMLD|+* z>j>yI%BWP^3k?c~ie3uEyUxfn-Qj3xK#otatDPMI{9@gBeFQ#S&0=3=#wr~X{>O|Z zD&GOUjqenxG-90b&&l)3zaUxiq&XIvO@yZKk3<*n%5_?Gk8?_mp?B{ delta 1796 zcmY*aTTGi(9Pgh&Y2?`BU^OS>~#iGBQGZMqFLgcK4{QnW7`YS#6^75I1~Tpd|z?C{Qm#*zn}B{&iS^t z^0&A0w{B}M=0&E)!mp)M^2tO8cs=SqCX>C3N3f8&ZJdW97QV)#*D%;@YQWuIGSwljnA*uz zkCN=PmMTKA>3BFDT_Tsw4YcV;IF5de*^PMF+<~}Z_Hs)D`Nv!)Y0g%rEw}3Pr)R=b zEP1)LQL0#to*!D<5eqD55c@1Wh#y#9Lfp5w5UZ>nj&^$30diC~tuG=zu%1P%YwJWD zZ|g$*u0uoa^_(CN+lv0T%BP=R;EAW(S%K4Li@Ks{`=-Gs|5U zU%qZ*qx4zY$e~S*TArPg!S3ay*6lX5-Ld--)ed$5Y?hC(;-M|?7~AlMqYteYof`7Z zc{R8A?A1)CqeD={4VOCFFocKuaSaCz5xj=MBu z#4Q%~yKH=@Mr$#->8e5Rrd2~8y6RDryB&yZt0V4HsJ-PjB7W{R+1b}mDaMmip+sbQ zD*fhv7f2-M0g?rcMdGb8cJVufv?nikEJ*C2M~^t~X-2%|F(7{HF(N+o)FJA;rx1I+ zjfnH!TEy#K7J0|3JjVX~|uxWhYGw0^DUrq2g5vq$-S_ z)V~Ln^s_xs)As{Vi6yoI(1c<;2palV0PyqE;(lmB;pzuH3ZWnHaGB6b9A!C3Cu_0T z+CU!%po;D~p(K|zq+U1FiLN^8b78-CT#STNxB&QBn5gBXm7-mMmytd~tLW6w?}r#Y zs4)om0h!Q{m`#OhD#%B|Va;NLYGQU&D{$M`H&ufR4dYfWKM2zRPahosOZJS+4(Ygb zWY(bjNln90DHpd& zm40XvIa2a!IMH=pnCXth!u>*Gf>B_081PNnd3zW>S
-getOneDRegisterAccessor(userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7fc6483efd90>]] = None) → deviceaccess.OneDRegisterAccessor[source]
+getOneDRegisterAccessor(userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa8109d30>]] = 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 0x7fc646f3b5e0>[source]
+getRegisterCatalogue() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa6c595b0>[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 0x7fc6483efd90>]] = None) → deviceaccess.ScalarRegisterAccessor[source]
+getScalarRegisterAccessor(userType, registerPathName: str, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa8109d30>]] = 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 0x7fc6483efd90>]] = None) → deviceaccess.TwoDRegisterAccessor[source]
+getTwoDRegisterAccessor(userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa8109d30>]] = 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 0x7fc6483efd90>]] = None) → deviceaccess.VoidRegisterAccessor[source]
+getVoidRegisterAccessor(registerPathName: str, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa8109d30>]] = 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 0x7fc6483ef7c0>[source]
+dataValidity() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa8109760>[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 0x7fc6483efd90>][source]
+getAccessModeFlags() → Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa8109d30>][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 0x7fc64841e6a0>[source]
+getId() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa813b640>[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 0x7fc6473260a0>[source]
+getVersionNumber() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa7043070>[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 0x7fc6483efd90>]] = None)[source]
+class deviceaccess.NumpyGeneralRegisterAccessor(channels, elementsPerChannel, userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa8109d30>]] = None)[source]

Bases: deviceaccess.GeneralRegisterAccessor

@@ -1029,7 +1029,7 @@
-class deviceaccess.OneDRegisterAccessor(userType, accessor, accessModeFlags: Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7fc6483efd90>])[source]
+class deviceaccess.OneDRegisterAccessor(userType, accessor, accessModeFlags: Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa8109d30>])[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 0x7fc6483efd90>]] = None)[source]
+class deviceaccess.ScalarRegisterAccessor(userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa8109d30>]] = 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 0x7fc6473260a0>] = None) → None[source]
+setAndWrite(newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa7043070>] = 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 0x7fc6473260a0>] = None, validity: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc6483ef7c0> = <sphinx.ext.autodoc.importer._MockObject object>) → None[source]
+writeIfDifferent(newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa7043070>] = None, validity: <sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa8109760> = <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 0x7fc6483efd90>]] = None)[source]
+class deviceaccess.TwoDRegisterAccessor(userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7f9aa8109d30>]] = 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 848db68e8fc..ec031f5da21 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,"0x7fc646f3b5e0":0,"0x7fc6473260a0":0,"0x7fc6483ef7c0":0,"0x7fc6483efd90":0,"0x7fc64841e6a0":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,"0x7f9aa6c595b0":0,"0x7f9aa7043070":0,"0x7f9aa8109760":0,"0x7f9aa8109d30":0,"0x7f9aa813b640":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 193744fbb0c33280161af6fb3696a6de15789f8f..758813a26959572250306503a367da53d5dc6bcc 100644 GIT binary patch delta 1129 zcmbRFTwvyNfenXzInyjtlFTd(lT#)qo|K)w-;7ygviy10>8p4c1ty31fH)kRb^W$5 zA}MS*?Ydb%K!piOX#MOw9=J&ccCphBrZ9?cej8+B3sRJ5m}+Edx>;+&Ca^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*xodWaW&j9a|3u7fh-0}H%?((#ST-RoU+|y4&!k~QRIN1lEEH3B}25wXYxXS2PBn| z^B7l1LiowXrm5Sxb}&wZS_I-FSp=5;vXimZ3Zy*IG&#w@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({yMSO4o delta 1129 zcmbRFTwvyNfenXzIg`yz4U7y@Qw%02o|K)w-;7ygviy10>8p4c1ty31fH)kRb^W$5 zA}MS*?Ydb%K!piOX#MOw9=J&ccCphBrZ9?cej8+B3shv1nqp>PYOz^s!X}V0Q10}V zI~ko2+|34)8d#A`1i9vY2(uW>H9VXDPT!C23a(jmkcF_j!eNetF2dl=i6_O7T)w&C zbS4saGIk@H&%FS71UaP6-++YFc3?;?LUu&MX_?760nXF6@G;In(u39D?a%lbCpW=V znHz6!n#8yoZkV|-ER4Vw1Em|MFs@>UDNixjZZe1QIHM@sVZeZ&lEDtdqCGy77y3IO zsf?V*xIz-bH!(0X+|IRwaT?Sj5Fg1Ru=JOmjICBc2isTO50~9GFLDn3r~LQFFD;bnfVgXL|AYMq%bETs{v<^?Nd^iOGS}X zxz{km^CK|s=hiTrZl7Dlybw9yQPpe*s*ymJ#%j@Yr#j|(nExOKTTN%FXLdyuGn<}M i!^F3JT0OImI7|kZ#(;6T2tB}V&mV$_4`fCF diff --git a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/.doctrees/environment.pickle b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/.doctrees/environment.pickle index 7d712a86e36cb24f58ac48098b9e5687925e0d56..11a731d81b8aa727df482423c04079e5dd727454 100644 GIT binary patch delta 1873 zcmY*aZA?>V6y_)`RdIz-YE`Nf3e-}%mKI9s7YKq1D@ySAKCX76ER^Qnry#D+xSDkZJtRH1l$Vlo*{ zNehxGmfccP(%=2)@oVRwy#G^dzQ}&7NyX-h?CI#YWUIjgSrRae!5q14xK__H7bKp7 z7Z$r9Wpc`NG#!t~+GM=$PqNKePh$1gl`JB5h0IuVWVt~>EXH$YCK0>JfEAA2Wx&He zK`WChO&7adTQ}N(c$zE8?#4&NZP62T(>kecF_ImodoaKDxhb^;X(btK-V~MAd8L;v z_lc^}NZc(OYF2Fkc&ULcu{mP29)x*v%4%1$>MJqd){>HCd?fR0H?3!2Ckwy8qc31^ zv#km5e#F**_?E35F>h-|+^}^berInYe!G_QCX%&Rp|xTU@Dranr=3H<0tQ>n9F1kO zk1aZ}I2yxxvMO^UeNzkR+ekzg zngcAaFJMNT3DhHA4p^LQ6`SAJaR=9I$IG8VmimIQznaZ&uDq8ozcn0Brr7(XGeM}s2q_3S z$@Bwcr7Vyx4T4e0Q}&Tfd#!NZ8HBnn?%W~kB&Q<@lwr~ZmpsP*tyY+3=G#RK9lM3H zkr*6}!Zec^=U%ets1&r3(=Qx51=Vv};Vczx+~|b*qNOh%OGNQG@E(jj@Jr_ok!Rvm z-KG}Qfc13c(L_2jJDZtiIn+7~7QF9&hCwf{LD4Sm0KGj7W}#5S6bf6wA`gf@-tod7 zwgN@gTxcBQNx-8}$qkyBfV>v;$K!zGOko5}BJu4$kP|I*sSgaRZk$ z06o*&%9{Uq1lq-ch8TJ@g&KI9J$$Ye^w=nD7ZFP0Y!agC^g#K!N z*W%=o8>)2tg{f1Kbni={>Aq+@ax9dd!v5}_8;5rn>2wfGbZQ8y=noG-tK&PNmZy%5 z*u-q;430Rx_z-HuX<@eIX=54m&I8bxd2S_sBPS+Lho&du$#94-7XP>8RO}#{IGJQ> V&mV$L!{YJJCI2|nQYLf4`Y#0kMyUV* delta 1883 zcmY*aOH3PA6y*XoZUQkD2Ac#DjE!xKacyic#y?Q+Fy3Zme z6#E7toheNfrrg}tS%Fly>WEqYP>|e4NfnVBwuwxyBL|HSV0rU9<9sou3NqBPOa9i^ zlL_+|#NDDGwfZXJYTc2u9S4DLH&`57B09@)SSIH!HaVMME#@sLDq6+Ivb_1RWdSM} z{VHc)MRJSPfKMQ3Z6Ye4oV;f>VwSVEAnsVZ$e^#1JhQ2Z&sM`L2C{6c!f4IrNBqg= zbVTV_k*95J8;Sim;z|1{#C7`##BI9=am7?C(RtkLFdC&!!$9`z$$bh6n_+S{pr0+bl;JDFSDo$TIiDD??$EVO>r zIf%728?Vv3L6Be?aP_dFD}boL`S)Dx8M!;_$g5pijDlV5VtzAFL+*4)$d_F*tgxxD zLO&aWLzuFiSlTcMQo1_^6DUfhke$rm@G6|o>DKAitEp^kt&~-k zHvjSe4zRfSYfpcrjM?^0Jbs(j(egc5q}~7=Q!v|R%KP|-z!Hup=c#53TIl-$&>-d0 z05p~|3cWl8Iw>a~CA+o;p?Gfy8oPP%ps0|Xi6qcxOf+8-J^TNC7UrTU<{ws55lv^U zpsXVryIu%QWY%$nT(T>KRL|4z?G-{=&(lgrsW8T!F3=XD`ttEa6rTVW*Ky(xj)Ov< zk*D%@xsYmbKXrLDk&4XCrDs?VwTyrn@B76F)QiS1#0A&WyCYx{6zZ5l-uH~zEX?tt z2M#mS7qXW8;K(O_w?rlmXkr55L7-1Z0S!zc2u7jtoqiA-&Gd3VXx3fmQhF^220^Zo zUiU*i(<@=aKMO*Ku%INGUS)m{yv<(jWC6D^mBe7 z=#OJy5f!Oz2x^3}{v3cNoTGaj+Jr*SAgHmhIt~qZ$&G{f7Ih@#sl}lM*7MVFR1h;@ zy_(;(uyWl6RcijiV(z2)kO>P-g}QhY2v*K{8Ua(T?oxg#*^U?KWF?elaaB7 aXyROwsqJrpTFLnM4-@~HscbrZ*76_P|3mEn diff --git a/ChimeraTK-DeviceAccess-PythonBindings/tag/html/deviceaccess.html b/ChimeraTK-DeviceAccess-PythonBindings/tag/html/deviceaccess.html index fbf33e2d910..53d658eec96 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 0x7fc75020ed00>]] = None) → deviceaccess.OneDRegisterAccessor[source]
+getOneDRegisterAccessor(userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7ff9db691cd0>]] = 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 0x7fc74ed60580>[source]
+getRegisterCatalogue() → <sphinx.ext.autodoc.importer._MockObject object at 0x7ff9da1e2550>[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 0x7fc75020ed00>]] = None) → deviceaccess.ScalarRegisterAccessor[source]
+getScalarRegisterAccessor(userType, registerPathName: str, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7ff9db691cd0>]] = 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 0x7fc75020ed00>]] = None) → deviceaccess.TwoDRegisterAccessor[source]
+getTwoDRegisterAccessor(userType, registerPathName: str, numberOfElements: int = 0, elementsOffset: int = 0, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7ff9db691cd0>]] = 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 0x7fc75020ed00>]] = None) → deviceaccess.VoidRegisterAccessor[source]
+getVoidRegisterAccessor(registerPathName: str, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7ff9db691cd0>]] = 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 0x7fc75020e730>[source]
+dataValidity() → <sphinx.ext.autodoc.importer._MockObject object at 0x7ff9db691700>[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 0x7fc75020ed00>][source]
+getAccessModeFlags() → Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7ff9db691cd0>][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 0x7fc750240610>[source]
+getId() → <sphinx.ext.autodoc.importer._MockObject object at 0x7ff9db6c35e0>[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 0x7fc74f148f10>[source]
+getVersionNumber() → <sphinx.ext.autodoc.importer._MockObject object at 0x7ff9da5cb070>[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 0x7fc75020ed00>]] = None)[source]
+class deviceaccess.NumpyGeneralRegisterAccessor(channels, elementsPerChannel, userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7ff9db691cd0>]] = None)[source]

Bases: deviceaccess.GeneralRegisterAccessor

@@ -1029,7 +1029,7 @@
-class deviceaccess.OneDRegisterAccessor(userType, accessor, accessModeFlags: Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7fc75020ed00>])[source]
+class deviceaccess.OneDRegisterAccessor(userType, accessor, accessModeFlags: Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7ff9db691cd0>])[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 0x7fc75020ed00>]] = None)[source]
+class deviceaccess.ScalarRegisterAccessor(userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7ff9db691cd0>]] = 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 0x7fc74f148f10>] = None) → None[source]
+setAndWrite(newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7ff9da5cb070>] = 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 0x7fc74f148f10>] = None, validity: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc75020e730> = <sphinx.ext.autodoc.importer._MockObject object>) → None[source]
+writeIfDifferent(newValue: numpy.number, versionNumber: Optional[<sphinx.ext.autodoc.importer._MockObject object at 0x7ff9da5cb070>] = None, validity: <sphinx.ext.autodoc.importer._MockObject object at 0x7ff9db691700> = <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 0x7fc75020ed00>]] = None)[source]
+class deviceaccess.TwoDRegisterAccessor(userType, accessor, accessModeFlags: Optional[Sequence[<sphinx.ext.autodoc.importer._MockObject object at 0x7ff9db691cd0>]] = 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 c29796a4ce1..f1ed7442af8 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:{"0x7f5298a8f400":0,"0x7f52b5f8a740":0,"0x7fc74ed60580":0,"0x7fc74f148f10":0,"0x7fc75020e730":0,"0x7fc75020ed00":0,"0x7fc750240610":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,"0x7ff9da1e2550":0,"0x7ff9da5cb070":0,"0x7ff9db691700":0,"0x7ff9db691cd0":0,"0x7ff9db6c35e0":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 5e33103ec0b..b2e6e409a39 100644 --- a/index.html +++ b/index.html @@ -242,7 +242,7 @@

ChimeraTK Documentation

- Generated on Sat Jan 11 06:43:18 UTC 2025 in 798 seconds. + Generated on Tue Jan 14 06:39:18 UTC 2025 in 558 seconds.