Come comunicare tra dm-script e python in Digital Micrograph
Come comunico tra dm-script
codice e python
codice, entrambi eseguiti in Digital Micrograph?
Nel mio caso specifico ho dialoghi complicati. Sice i dialoghi non sono supportati in python
ma in dm-script
, ho scritto i miei dialoghi in dm-script
. Il problema ora è passare dalla finestra di dialogo al codice python.
Considera il seguente esempio:
import DigitalMicrograph as DM
script = """string field_value = "";
class ButtonDialog : UIFrame{
void field_changed(object self, TagGroup field){
field_value = field.DLGGetStringValue();
}
object init(object self){
TagGroup dlg, dlg_items, field;
dlg = DLGCreateDialog("Type in a number", dlg_items);
dlg.DLGAddElement(DLGCreateLabel("Number:"));
field = DLGCreateIntegerField(0, 10, "field_changed");
dlg.DLGAddElement(field);
self.super.init(dlg);
return self;
}
}
object dialog = alloc(ButtonDialog).init();
dialog.pose();
"""
DM.ExecuteScriptString(script)
# how do I get this?
field_value = ""
Risposte
Script DM che chiamano script Python
Questa risposta mostra una certa comunicazione tra Python e DM-script ma forma il lato opposto. Utilizza anche il tagGroup persistente come proxy di trasferimento.
Passaggio di valori semplici dentro e fuori Python da uno script DM
// //////////////////////////////////////////////////
// Helper methods
// Build the DM-String representing the PythonScript
// which is then called
// //////////////////////////////////////////////////
string AddPythonValueIN( number val, string valName, string valType )
{
string py
py += "\n#Get value DM->Python via global tags" + "\n"
py += "success, " + valName + " = DM.GetPersistentTagGroup().GetTagAs" + valType + "('Python_temp:in:" + valName + "')" + "\n"
py += "if False == success:" + "\n"
py += " print( 'Error. No value passed in by DM-script sucessfully.' )" + "\n"
py += " exit(0)" + "\n"
return py
}
string AddPythonValueIN( string val, string valName, string valType )
{
string py
py += "\n#Get value DM->Python via global tags" + "\n"
py += "success, " + valName + " = DM.GetPersistentTagGroup().GetTagAs" + valType + "('Python_temp:in:" + valName + "')" + "\n"
py += "if False == success:" + "\n"
py += " print( 'Error. No value passed in by DM-script sucessfully.' )" + "\n"
py += " exit(0)" + "\n"
return py
}
string AddPythonValueOut( string valName, string valType )
{
string py
py += "\n#Get value Python->DM via global tags" + "\n"
py += "DM.GetPersistentTagGroup().SetTagAs" + valType + "('Python_temp:out:" + valName + "'," + valName + ")" + "\n"
return py
}
string AddPythonPrintModifyPrint()
{
string py
py += "\n#Print InValue, modify, print OutValue" + "\n"
py += "print('InValue',InValue)"+ "\n"
py += "OutValue = InValue * 2" + "\n"
py += "print('OutValue',OutValue)"+ "\n"
return py
}
// //////////////////////////////////////////////////
// Example calls
// Demonstrating value passing from DM script to a
// called Python snippet. TagTypes need to be
// explicit in Python.
// //////////////////////////////////////////////////
void PythonValueInAndOut_Float()
{
number value = 13.2
GetPersistentTagGroup().TagGroupSetTagAsFloat("Python_temp:in:InValue",value)
Result( " DM-Script passed value in: " + value + "\n")
string py = "#Script to demonstrate value passing in Hybrid scripts. DM calling Python." + "\n"
py += AddPythonValueIN( value, "InValue", "Float" )
py += AddPythonPrintModifyPrint()
py += AddPythonValueOut( "OutValue", "Float" )
Result( "\n PYTHON CODE EXECUTES\n --------------------- \n\n" )
ExecutePythonScriptString( py, 1 )
Result( "\n --------------------- \n PYTHON CODE FINISHED \n\n" )
if ( !GetPersistentTagGroup().TagGroupGetTagAsFloat("Python_temp:out:OutValue",value))
Throw("Python value passed out not found.")
Result( "DM-Script received value: " + value + "\n")
GetPersistentTagGroup().TagGroupDeleteTagWithLabel("Python_temp")
}
void PythonValueInAndOut_Double()
{
number value = 13.2
GetPersistentTagGroup().TagGroupSetTagAsDouble("Python_temp:in:InValue",value)
Result( " DM-Script passed value in: " + value + "\n")
string py = "#Script to demonstrate value passing in Hybrid scripts. DM calling Python." + "\n"
py += AddPythonValueIN( value, "InValue", "Double" )
py += AddPythonPrintModifyPrint()
py += AddPythonValueOut( "OutValue", "Double" )
Result( "\n PYTHON CODE EXECUTES\n --------------------- \n\n" )
ExecutePythonScriptString( py, 1 )
Result( "\n --------------------- \n PYTHON CODE FINISHED \n\n" )
if ( !GetPersistentTagGroup().TagGroupGetTagAsDouble("Python_temp:out:OutValue",value))
Throw("Python value passed out not found.")
Result( "DM-Script received value: " + value + "\n")
GetPersistentTagGroup().TagGroupDeleteTagWithLabel("Python_temp")
}
void PythonValueInAndOut_String()
{
string value = "hallo"
GetPersistentTagGroup().TagGroupSetTagAsString("Python_temp:in:InValue",value)
Result( " DM-Script passed value in: " + value + "\n")
string py = "#Script to demonstrate value passing in Hybrid scripts. DM calling Python." + "\n"
py += AddPythonValueIN( value, "InValue", "String" )
py += AddPythonPrintModifyPrint()
py += AddPythonValueOut( "OutValue", "String" )
Result( "\n PYTHON CODE EXECUTES\n --------------------- \n\n" )
ExecutePythonScriptString( py, 1 )
Result( "\n --------------------- \n PYTHON CODE FINISHED \n\n" )
if ( !GetPersistentTagGroup().TagGroupGetTagAsString("Python_temp:out:OutValue",value))
Throw("Python value passed out not found.")
Result( "DM-Script received value: " + value + "\n")
GetPersistentTagGroup().TagGroupDeleteTagWithLabel("Python_temp")
}
ClearResults()
PythonValueInAndOut_float()
PythonValueInAndOut_double()
PythonValueInAndOut_string()
Passaggio di dati immagine dentro e fuori Python da uno script DM
// Images and other objects which are in memory can be most easily passed
// by passing their ID value and then finding them by ID.
// However, this does not work if the object would go out of scope at the
// end of a script (like an image which is not displayed)
//
// To pass a NumpyArray out of Python without showing an image, one can
// instead write the array to the global tags directly, together with the
// information needed to read the tags out into a DM-image
void PythonImageInOut( )
{
image img := RealImage("test",4,5,5)
img = icol
Result( " DM-Script passed image ["+img.ImageGetLabel()+"] in.\n")
string py
py += "\n#Get image DM->Python via imageLabel" + "\n"
py += "img = DM.FindImageByID("+ img.ImageGetID()+")" + "\n"
py += "if None == img:" + "\n"
py += " print( 'Error.No image passed in by DM-script sucessfully.' )" + "\n"
py += " exit(0)" + "\n"
py += "\n"
py += "print('Image from DM: Label = ', img.GetLabel())" + "\n"
py += "print('Image from DM: Name = ', img.GetName())" + "\n"
py += "print('Image from DM: Value = \\n', img.GetNumArray())" + "\n"
py += "del img #ALWAYS delete DM objects in Python scripts" + "\n"
py += "\n"
py += "\n#Create DM image in Python and pass out as ID via global tags" + "\n"
py += "import numpy as np" + "\n"
py += "data = np.arange(48).reshape(6,8)" + "\n"
py += "outImg = DM.CreateImage(data.copy(order='C'))" + "\n"
py += "DM.GetPersistentTagGroup().SetTagAsLong('Python_temp:out:ID',outImg.GetID())" + "\n"
py += "print('Create new image with ID:',outImg.GetID())"+"\n"
py += "outImg.ShowImage() #Image needs to be shown or it will not stay in memory" + "\n"
py += "del outImg #ALWAYS delete DM objects in Python scripts" + "\n"
Result( "\n PYTHON CODE EXECUTES\n --------------------- \n\n" )
ExecutePythonScriptString( py, 1 )
Result( "\n --------------------- \n PYTHON CODE FINISHED \n\n" )
number imgID
if ( !GetPersistentTagGroup().TagGroupGetTagAsLong("Python_temp:out:ID",imgID))
Throw("Python imageID value passed out not found.")
image outImg := FindImageByID(imgID)
if ( !outImg.ImageIsValid() )
Throw("Python imageID value passed out but no matching image found.")
Result( "DM-Script received image: " + outImg.ImageGetLabel()+ "\n")
GetPersistentTagGroup().TagGroupDeleteTagWithLabel("Python_temp")
}
void PythonArrayOut( )
{
string py
py += "#Passing Numpy array values via global tags" + "\n"
py += "import numpy as np" + "\n"
py += "data = np.arange(6*8*3).reshape(6,8,3)" + "\n"
py += "outImg = DM.CreateImage(data.copy(order='C'))" + "\n"
py += "DM.GetPersistentTagGroup().SetTagAsArray('Python_temp:out:array',outImg)" + "\n"
py += "DM.GetPersistentTagGroup().SetTagAsLong('Python_temp:out:type',outImg.GetDataType())" + "\n"
py += "for i in range(data.ndim,0,-1):" + "\n"
py += " DM.GetPersistentTagGroup().SetTagAsLong('Python_temp:out:dim:' + str(i-1),data.shape[i-1])" + "\n"
py += "\n"
py += "del outImg #ALWAYS delete DM objects in Python scripts" + "\n"
Result( "\n PYTHON CODE EXECUTES\n --------------------- \n\n" )
ExecutePythonScriptString( py, 1 )
Result( "\n --------------------- \n PYTHON CODE FINISHED \n\n" )
number dataType
if ( !GetPersistentTagGroup().TagGroupGetTagAsLong("Python_temp:out:type",dataType))
Throw("Python dataType value passed out not found.")
TagGroup dimTG
if ( !GetPersistentTagGroup().TagGroupGetTagAsTagGroup("Python_temp:out:dim",dimTG))
Throw("Python dimensions passed out not found.")
number nDim = dimTG.TagGroupCountTags()
number n0, n1, n2, n3, n4
dimTG.TagGroupGetIndexedTagAsLong(0,n0)
dimTG.TagGroupGetIndexedTagAsLong(1,n1)
dimTG.TagGroupGetIndexedTagAsLong(2,n2)
dimTG.TagGroupGetIndexedTagAsLong(3,n3)
dimTG.TagGroupGetIndexedTagAsLong(4,n4)
image outImg
if ( 1 == nDim )
outImg := NewImage("Test", dataType, n0 )
else if ( 2 == nDim )
outImg := NewImage("Test", dataType, n0, n1 )
else if ( 3 == nDim )
outImg := NewImage("Test", dataType, n0, n1, n2 )
else if ( 4 == nDim )
outImg := NewImage("Test", dataType, n0, n1, n2, n3 )
else if ( 5 == nDim )
outImg := NewImage("Test", dataType, n0, n1, n2, n3, n4 )
if ( !GetPersistentTagGroup().TagGroupGetTagAsArray("Python_temp:out:array",outImg))
Throw("Python array data passed out not found.")
Result("\n DM recreated image from array values: " + outImg.ImageGetLabel()+ "\n")
GetPersistentTagGroup().TagGroupDeleteTagWithLabel("Python_temp")
}
clearresults()
Result("\n\nEXAMPLE Python<->DM image passing\n")
PythonImageInOut()
Result("\n\nEXAMPLE Python-->DM array passing\n")
PythonArrayOut( )
Per sincronizzare i dati tra dm-script
e python
mentre entrambi sono in esecuzione nella stessa istanza (e il thread in questo esempio, può essere modificato anche per thread diversi) è possibile utilizzare i tag persistenti .
Sta dm-script
impostando i tag persistenti. python
può quindi leggere di nuovo i tag persistenti.
Aggiornamento: modulo Python
A causa delle limitazioni menzionate di seguito e del codice in continua crescita e illeggibile, ho deciso di scrivere il mio modulo python per questo. Con execdmscriptuno è possibile eseguire molto facilmente codice dm-script con sincronizzazione delle variabili da Digital Micrograph.
Guarda il seguente esempio:
from execdmscript import exec_dmscript
# some script to execute
dmscript = """
number input;
number s = GetNumber("Enter a number between " + min + " and " + max + ".", init, input);"
"""
# variables that will be defined for the dm-scripts (and readable later on in python)
sv = {"min": 1, "max": 10, "init": 2}
# variables the dm-script defines and that should be readable in the python file
rv = {"input": "number", "s": "number"}
with exec_dmscript(dmscript, readvars=rv, setvars=sv) as script:
if script["s"]:
print(script["input"])
else:
print("User pressed cancel.")
Questo nasconde tutti i problemi e il salvataggio relativi a dm-script (menzionati di seguito). Esso permette di utilizzare list
e dict
S e tipi di base come bool
, str
, int
e float
. Tutti i tipi e i valori possono essere usati in modo pitonico senza bisogno di preoccuparsi dei tipi dm-script. Il dm-script può essere spostato in un file separato per ripulire ancora di più il codice.
Nota che per il debug c'è un exec_dmscript(debug=True, debug_file="path/to/file")
interruttore che salverà il codice nel file debug_file
. Questo file può quindi essere eseguito manualmente in GMS che mostra gli errori.
Disclaimer : come accennato, sono l'autore del execdmscriptmodulo. Tuttavia penso che questa sia la soluzione migliore per questo caso. In effetti questa domanda è stata la ragione per cui ho scritto il modulo.
Tipi di dati di base
Per tipi di dati di base come string
e number
si può creare e aggiungere il codice a mano. L'esempio seguente mostra l'idea:
import DigitalMicrograph as DM
import time
sync_id = "sync-{}".format(int(time.time() * 100))
dmscript = """
number input;
number s = GetNumber("Enter a number between {min} and {max}.", {init}, input);
TagGroup p = GetPersistentTagGroup();
p.TagGroupSetTagAsBoolean("{id}-success", s);
p.TagGroupSetTagAsLong("{id}-input", input);
"""
DM.ExecuteScriptString(dmscript.format(min=1, max=10, init=2, id=sync_id))
# cannot save TagGroups to variables, check below
s, success = DM.GetPersistentTagGroup().GetTagAsBoolean("{}-success".format(sync_id))
if s and success:
# cannot save TagGroups to variables, check below
s, input = DM.GetPersistentTagGroup().GetTagAsLong("{}-input".format(sync_id))
if s:
print(input)
else:
print("Did not find 'input' in persistent tags.")
elif not s:
print("Did not find 'success' in persistent tags.")
else:
print("User clicked cancel.")
# cannot save TagGroups to variables, check below
# delete tag, otherwise the persistent tags gets filled with garbage
DM.GetPersistentTagGroup().DeleteTagWithLabel("{}-success".format(sync_id))
DM.GetPersistentTagGroup().DeleteTagWithLabel("{}-input".format(sync_id))
Come si può vedere ci sono alcuni aspetti negativi di questo metodo. C'è molto codice che crea la configurazione e la sincronizzazione per l'immissione di un solo numero. Questo rende il codice disordinato. Inoltre si potrebbe voler salvare il codice dm-script in un file separato che aggiunge l'apertura del file python. Anche il debug del codice dm-script è difficile in questo codice. E infine ci sono limitazioni per TagGroup che viaggiano sul lato python (controlla sotto).
Limitazioni
Aggiornamento : il modulo python menzionato di seguito può gestire TagGrou
s e TagList
s perché li salva linearizzati e con chiavi e tipi separati.
Notare che i messaggi di posta TagGroup
elettronica sono molto difficili da sincronizzare. TagGroup
s non devono essere assegnati a variabili. Appena lo sono, non sono più utilizzabili. Questo può essere illustrato dal seguente codice molto semplice:
import DigitalMicrograph as DM
# create group for the example
group1 = DM.NewTagGroup()
group1.SetTagAsString("test-string", "test content")
print("Group 1 valid:", group1.IsValid(), "(type:", type(group1), ")")
# save to persistent tags
DM.GetPersistentTagGroup().SetTagAsTagGroup("test", group1)
# get the group without assigning to a variable, works
s, group2 = DM.GetPersistentTagGroup().GetTagAsTagGroup("test")
print("Group 2 success:", s, ", valid:", group2.IsValid(), "(type:", type(group2), ")")
# assign one parent group to a variable, doesn't work
tags = DM.GetPersistentTagGroup()
s, group3 = tags.GetTagAsTagGroup("test")
print("Group 3 success:", s, ", valid:", group3.IsValid(), "(type:", type(group3), ")")
Questo codice produrrà l'output
Group 1 valid: True (type: <class 'DigitalMicrograph.Py_TagGroup'> )
Group 2 success: True , valid: True (type: <class 'DigitalMicrograph.Py_TagGroup'> )
Group 3 success: True , valid: False (type: <class 'DigitalMicrograph.Py_TagGroup'> )
Questo mostra che non puoi assegnare TagGroup
s a variabili python.
Idee asincrone
Questo può essere esteso per applicazioni asincrone. La dm-script
e python
l'implementazione può impostare fili che osservano i tag persistenti. (Nota che puoi contrassegnare TagGroup
i messaggi come modificati utilizzando TagGroupMarkAsChanged()
), tag perferrabilmente diversi. Quindi entrambi possono aggiungere comandi e / o dati al tag. L'altra "istanza" può leggerli ed elaborarli.
Questo deve essere codificato manualmente. Questo (attualmente) non è incluso nel execdmscript
modulo.